2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.impl;
11 import com.google.common.base.Preconditions;
12 import com.google.common.net.InetAddresses;
13 import io.netty.channel.Channel;
14 import io.netty.channel.ChannelFuture;
15 import io.netty.channel.ChannelFutureListener;
16 import io.netty.handler.codec.ByteToMessageDecoder;
17 import io.netty.handler.codec.MessageToByteEncoder;
18 import java.net.Inet4Address;
19 import java.net.InetAddress;
20 import java.time.Instant;
21 import java.time.ZoneId;
22 import java.time.ZonedDateTime;
23 import java.time.format.DateTimeFormatter;
24 import java.util.regex.Matcher;
25 import java.util.regex.Pattern;
26 import org.opendaylight.netconf.api.NetconfMessage;
27 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
28 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
29 import org.opendaylight.netconf.nettyutil.AbstractNetconfSession;
30 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
31 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
32 import org.opendaylight.netconf.notifications.NetconfNotification;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1Builder;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionKey;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.DateAndTime;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.ZeroBasedCounter32;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession, NetconfServerSessionListener> implements NetconfManagementSession {
52 private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
53 private static final DateTimeFormatter dateFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
55 private final NetconfHelloMessageAdditionalHeader header;
56 private final NetconfServerSessionListener sessionListener;
58 private ZonedDateTime loginTime;
59 private long inRpcSuccess, inRpcFail, outRpcError, outNotification;
60 private volatile boolean delayedClose;
62 public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel, final long sessionId,
63 final NetconfHelloMessageAdditionalHeader header) {
64 super(sessionListener, channel, sessionId);
66 this.sessionListener = sessionListener;
67 LOG.debug("Session {} created", toString());
71 protected void sessionUp() {
72 Preconditions.checkState(loginTime == null, "Session is already up");
73 this.loginTime = Instant.now().atZone(ZoneId.systemDefault());
78 * Close this session after next message is sent.
79 * Suitable for close rpc that needs to send ok response before the session is closed.
81 public void delayedClose() {
82 this.delayedClose = true;
86 public ChannelFuture sendMessage(final NetconfMessage netconfMessage) {
87 final ChannelFuture channelFuture = super.sendMessage(netconfMessage);
88 if (netconfMessage instanceof NetconfNotification) {
90 sessionListener.onNotification(this, (NetconfNotification) netconfMessage);
92 // delayed close was set, close after the message was sent
94 channelFuture.addListener(new ChannelFutureListener() {
96 public void operationComplete(final ChannelFuture future) throws Exception {
101 return channelFuture;
104 public void onIncommingRpcSuccess() {
108 public void onIncommingRpcFail() {
112 public void onOutgoingRpcError() {
116 private static final String dateTimePatternString = DateAndTime.PATTERN_CONSTANTS.get(0);
117 private static final Pattern dateTimePattern = Pattern.compile(dateTimePatternString);
120 public Session toManagementSession() {
121 SessionBuilder builder = new SessionBuilder();
123 builder.setSessionId(getSessionId());
125 InetAddress address1 = InetAddresses.forString(header.getAddress());
126 if (address1 instanceof Inet4Address) {
127 address = new IpAddress(new Ipv4Address(header.getAddress()));
129 address = new IpAddress(new Ipv6Address(header.getAddress()));
131 builder.setSourceHost(new Host(address));
133 Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
134 String formattedDateTime = dateFormatter.format(loginTime);
136 Matcher matcher = dateTimePattern.matcher(formattedDateTime);
137 Preconditions.checkState(matcher.matches(), "Formatted datetime %s does not match pattern %s", formattedDateTime, dateTimePattern);
138 builder.setLoginTime(new DateAndTime(formattedDateTime));
140 builder.setInBadRpcs(new ZeroBasedCounter32(inRpcFail));
141 builder.setInRpcs(new ZeroBasedCounter32(inRpcSuccess));
142 builder.setOutRpcErrors(new ZeroBasedCounter32(outRpcError));
144 builder.setUsername(header.getUserName());
145 builder.setTransport(getTransportForString(header.getTransport()));
147 builder.setOutNotifications(new ZeroBasedCounter32(outNotification));
149 builder.setKey(new SessionKey(getSessionId()));
151 Session1Builder builder1 = new Session1Builder();
152 builder1.setSessionIdentifier(header.getSessionIdentifier());
153 builder.addAugmentation(Session1.class, builder1.build());
155 return builder.build();
158 private static Class<? extends Transport> getTransportForString(final String transport) {
161 return NetconfSsh.class;
163 return NetconfTcp.class;
165 throw new IllegalArgumentException("Unknown transport type " + transport);
170 protected NetconfServerSession thisInstance() {
175 protected void addExiHandlers(final ByteToMessageDecoder decoder, final MessageToByteEncoder<NetconfMessage> encoder) {
176 replaceMessageDecoder(decoder);
177 replaceMessageEncoderAfterNextMessage(encoder);
181 public void stopExiCommunication() {
182 replaceMessageDecoder(new NetconfXMLToMessageDecoder());
183 replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());