andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Yuta HIGUCHI | e3ae821 | 2017-04-20 10:18:41 -0700 | [diff] [blame] | 17 | package org.onosproject.netconf.ctl.impl; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 18 | |
| 19 | import org.onosproject.netconf.NetconfDevice; |
| 20 | import org.onosproject.netconf.NetconfDeviceInfo; |
Andrea Campanella | 101417d | 2015-12-11 17:58:07 -0800 | [diff] [blame] | 21 | import org.onosproject.netconf.NetconfException; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 22 | import org.onosproject.netconf.NetconfSession; |
Andrea Campanella | 8b1cb67 | 2016-01-25 13:58:58 -0800 | [diff] [blame] | 23 | import org.onosproject.netconf.NetconfSessionFactory; |
Andrea Campanella | 1cd641b | 2015-12-07 17:28:34 -0800 | [diff] [blame] | 24 | import org.slf4j.Logger; |
| 25 | import org.slf4j.LoggerFactory; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 26 | |
| 27 | import java.io.IOException; |
| 28 | |
| 29 | /** |
Ryan Goulding | d57dea4 | 2016-12-03 13:01:15 -0500 | [diff] [blame] | 30 | * Default implementation of a NETCONF device. |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 31 | */ |
Andrea Campanella | 950310c | 2016-02-12 18:14:38 -0800 | [diff] [blame] | 32 | public class DefaultNetconfDevice implements NetconfDevice { |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 33 | |
Andrea Campanella | 1cd641b | 2015-12-07 17:28:34 -0800 | [diff] [blame] | 34 | public static final Logger log = LoggerFactory |
Andrea Campanella | 50d2521 | 2016-02-26 13:06:23 -0800 | [diff] [blame] | 35 | .getLogger(DefaultNetconfDevice.class); |
Andrea Campanella | 1cd641b | 2015-12-07 17:28:34 -0800 | [diff] [blame] | 36 | |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 37 | private NetconfDeviceInfo netconfDeviceInfo; |
Andrea Campanella | 7e6200a | 2016-03-21 09:48:40 -0700 | [diff] [blame] | 38 | private boolean deviceState = true; |
Andrea Campanella | 7bbe7b1 | 2017-05-03 16:03:38 -0700 | [diff] [blame] | 39 | private final NetconfSessionFactory sessionFactory; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 40 | private NetconfSession netconfSession; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 41 | |
Yuta HIGUCHI | e3ae821 | 2017-04-20 10:18:41 -0700 | [diff] [blame] | 42 | // will block until hello RPC handshake completes |
Andrea Campanella | 950310c | 2016-02-12 18:14:38 -0800 | [diff] [blame] | 43 | /** |
| 44 | * Creates a new default NETCONF device with the information provided. |
Yuta HIGUCHI | 0454d70 | 2017-03-17 10:08:38 -0700 | [diff] [blame] | 45 | * The device gets created only if no exception is thrown while connecting to |
Andrea Campanella | 950310c | 2016-02-12 18:14:38 -0800 | [diff] [blame] | 46 | * it and establishing the NETCONF session. |
| 47 | * @param deviceInfo information about the device to be created. |
| 48 | * @throws NetconfException if there are problems in creating or establishing |
| 49 | * the underlying NETCONF connection and session. |
| 50 | */ |
| 51 | public DefaultNetconfDevice(NetconfDeviceInfo deviceInfo) |
Andrea Campanella | 8b1cb67 | 2016-01-25 13:58:58 -0800 | [diff] [blame] | 52 | throws NetconfException { |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 53 | netconfDeviceInfo = deviceInfo; |
Andrea Campanella | 7bbe7b1 | 2017-05-03 16:03:38 -0700 | [diff] [blame] | 54 | sessionFactory = new NetconfSessionMinaImpl.MinaSshNetconfSessionFactory(); |
| 55 | try { |
| 56 | netconfSession = sessionFactory.createNetconfSession(deviceInfo); |
| 57 | } catch (IOException e) { |
| 58 | deviceState = false; |
| 59 | throw new NetconfException("Cannot create connection and session for device " + |
| 60 | deviceInfo, e); |
| 61 | } |
| 62 | } |
| 63 | |
| 64 | // will block until hello RPC handshake completes |
| 65 | /** |
| 66 | * Creates a new default NETCONF device with the information provided. |
| 67 | * The device gets created only if no exception is thrown while connecting to |
| 68 | * it and establishing the NETCONF session. |
| 69 | * |
| 70 | * @param deviceInfo information about the device to be created. |
| 71 | * @param factory the factory used to create the session |
| 72 | * @throws NetconfException if there are problems in creating or establishing |
| 73 | * the underlying NETCONF connection and session. |
| 74 | */ |
| 75 | public DefaultNetconfDevice(NetconfDeviceInfo deviceInfo, NetconfSessionFactory factory) |
| 76 | throws NetconfException { |
| 77 | netconfDeviceInfo = deviceInfo; |
| 78 | sessionFactory = factory; |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 79 | try { |
Andrea Campanella | 8b1cb67 | 2016-01-25 13:58:58 -0800 | [diff] [blame] | 80 | netconfSession = sessionFactory.createNetconfSession(deviceInfo); |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 81 | } catch (IOException e) { |
Andrea Campanella | 7e6200a | 2016-03-21 09:48:40 -0700 | [diff] [blame] | 82 | deviceState = false; |
Andrea Campanella | 101417d | 2015-12-11 17:58:07 -0800 | [diff] [blame] | 83 | throw new NetconfException("Cannot create connection and session for device " + |
| 84 | deviceInfo, e); |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 85 | } |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | @Override |
| 89 | public boolean isActive() { |
| 90 | return deviceState; |
| 91 | } |
| 92 | |
| 93 | @Override |
| 94 | public NetconfSession getSession() { |
| 95 | return netconfSession; |
| 96 | } |
| 97 | |
| 98 | @Override |
| 99 | public void disconnect() { |
| 100 | deviceState = false; |
Andrea Campanella | 1cd641b | 2015-12-07 17:28:34 -0800 | [diff] [blame] | 101 | try { |
| 102 | netconfSession.close(); |
| 103 | } catch (IOException e) { |
Andrea Campanella | 50d2521 | 2016-02-26 13:06:23 -0800 | [diff] [blame] | 104 | log.warn("Cannot communicate with the device {} session already closed", netconfDeviceInfo); |
Andrea Campanella | 1cd641b | 2015-12-07 17:28:34 -0800 | [diff] [blame] | 105 | } |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | @Override |
| 109 | public NetconfDeviceInfo getDeviceInfo() { |
| 110 | return netconfDeviceInfo; |
| 111 | } |
Andrea Campanella | 8b1cb67 | 2016-01-25 13:58:58 -0800 | [diff] [blame] | 112 | |
Andrea Campanella | 8b1cb67 | 2016-01-25 13:58:58 -0800 | [diff] [blame] | 113 | |
andrea | eb70a94 | 2015-10-16 21:34:46 -0700 | [diff] [blame] | 114 | } |