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.handler.codec.ByteToMessageDecoder;
16 import io.netty.handler.codec.MessageToByteEncoder;
17 import java.net.Inet4Address;
18 import java.net.InetAddress;
19 import java.time.Instant;
20 import java.time.ZoneId;
21 import java.time.ZonedDateTime;
22 import java.time.format.DateTimeFormatter;
23 import java.util.regex.Matcher;
24 import java.util.regex.Pattern;
25 import org.opendaylight.netconf.api.NetconfMessage;
26 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
27 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
28 import org.opendaylight.netconf.nettyutil.AbstractNetconfSession;
29 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
30 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
31 import org.opendaylight.netconf.notifications.NetconfNotification;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1Builder;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionKey;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
49 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession,
50 NetconfServerSessionListener> implements NetconfManagementSession {
52 private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
53 private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
54 private static final String DATE_TIME_PATTERN_STRING = DateAndTime.PATTERN_CONSTANTS.get(0);
55 private static final Pattern DATE_TIME_PATTERN = Pattern.compile(DATE_TIME_PATTERN_STRING);
57 private final NetconfHelloMessageAdditionalHeader header;
58 private final NetconfServerSessionListener sessionListener;
60 private ZonedDateTime loginTime;
61 private long inRpcSuccess;
62 private long inRpcFail;
63 private long outRpcError;
64 private long outNotification;
65 private volatile boolean delayedClose;
67 public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel,
68 final long sessionId, final NetconfHelloMessageAdditionalHeader header) {
69 super(sessionListener, channel, sessionId);
71 this.sessionListener = sessionListener;
72 LOG.debug("Session {} created", this);
76 protected void sessionUp() {
77 Preconditions.checkState(loginTime == null, "Session is already up");
78 this.loginTime = Instant.now().atZone(ZoneId.systemDefault());
83 * Close this session after next message is sent.
84 * Suitable for close rpc that needs to send ok response before the session is closed.
86 public void delayedClose() {
87 this.delayedClose = true;
91 public ChannelFuture sendMessage(final NetconfMessage netconfMessage) {
92 final ChannelFuture channelFuture = super.sendMessage(netconfMessage);
93 if (netconfMessage instanceof NetconfNotification) {
95 sessionListener.onNotification(this, (NetconfNotification) netconfMessage);
97 // delayed close was set, close after the message was sent
99 channelFuture.addListener(future -> close());
101 return channelFuture;
104 public void onIncommingRpcSuccess() {
108 public void onIncommingRpcFail() {
112 public void onOutgoingRpcError() {
117 public Session toManagementSession() {
118 SessionBuilder builder = new SessionBuilder();
120 builder.setSessionId(getSessionId());
122 InetAddress address1 = InetAddresses.forString(header.getAddress());
123 if (address1 instanceof Inet4Address) {
124 address = new IpAddress(new Ipv4Address(header.getAddress()));
126 address = new IpAddress(new Ipv6Address(header.getAddress()));
128 builder.setSourceHost(new Host(address));
130 Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
131 String formattedDateTime = DATE_FORMATTER.format(loginTime);
133 Matcher matcher = DATE_TIME_PATTERN.matcher(formattedDateTime);
134 Preconditions.checkState(matcher.matches(), "Formatted datetime %s does not match pattern %s",
135 formattedDateTime, DATE_TIME_PATTERN);
136 builder.setLoginTime(new DateAndTime(formattedDateTime));
138 builder.setInBadRpcs(new ZeroBasedCounter32(inRpcFail));
139 builder.setInRpcs(new ZeroBasedCounter32(inRpcSuccess));
140 builder.setOutRpcErrors(new ZeroBasedCounter32(outRpcError));
142 builder.setUsername(header.getUserName());
143 builder.setTransport(getTransportForString(header.getTransport()));
145 builder.setOutNotifications(new ZeroBasedCounter32(outNotification));
147 builder.withKey(new SessionKey(getSessionId()));
149 Session1Builder builder1 = new Session1Builder();
150 builder1.setSessionIdentifier(header.getSessionIdentifier());
151 builder.addAugmentation(Session1.class, builder1.build());
153 return builder.build();
156 private static Class<? extends Transport> getTransportForString(final String transport) {
159 return NetconfSsh.class;
161 return NetconfTcp.class;
163 throw new IllegalArgumentException("Unknown transport type " + transport);
168 protected NetconfServerSession thisInstance() {
173 protected void addExiHandlers(final ByteToMessageDecoder decoder,
174 final MessageToByteEncoder<NetconfMessage> encoder) {
175 replaceMessageDecoder(decoder);
176 replaceMessageEncoderAfterNextMessage(encoder);
180 public void stopExiCommunication() {
181 replaceMessageDecoder(new NetconfXMLToMessageDecoder());
182 replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());