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 io.netty.channel.Channel;
13 import io.netty.channel.ChannelFuture;
14 import io.netty.channel.ChannelFutureListener;
15 import io.netty.handler.codec.ByteToMessageDecoder;
16 import io.netty.handler.codec.MessageToByteEncoder;
17 import java.time.Instant;
18 import java.time.ZoneId;
19 import java.time.ZonedDateTime;
20 import java.time.format.DateTimeFormatter;
21 import java.util.regex.Matcher;
22 import java.util.regex.Pattern;
23 import org.opendaylight.netconf.api.NetconfMessage;
24 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
25 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
26 import org.opendaylight.netconf.nettyutil.AbstractNetconfSession;
27 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
28 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.DomainName;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1Builder;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionKey;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.DateAndTime;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.ZeroBasedCounter32;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
44 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession, NetconfServerSessionListener> implements NetconfManagementSession {
46 private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
47 private static final DateTimeFormatter dateFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
49 private final NetconfHelloMessageAdditionalHeader header;
51 private ZonedDateTime loginTime;
52 private long inRpcSuccess, inRpcFail, outRpcError;
53 private volatile boolean delayedClose;
55 public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel, final long sessionId,
56 final NetconfHelloMessageAdditionalHeader header) {
57 super(sessionListener, channel, sessionId);
59 LOG.debug("Session {} created", toString());
63 protected void sessionUp() {
64 Preconditions.checkState(loginTime == null, "Session is already up");
65 this.loginTime = Instant.now().atZone(ZoneId.systemDefault());
70 * Close this session after next message is sent.
71 * Suitable for close rpc that needs to send ok response before the session is closed.
73 public void delayedClose() {
74 this.delayedClose = true;
78 public ChannelFuture sendMessage(final NetconfMessage netconfMessage) {
79 final ChannelFuture channelFuture = super.sendMessage(netconfMessage);
80 // delayed close was set, close after the message was sent
82 channelFuture.addListener(new ChannelFutureListener() {
84 public void operationComplete(final ChannelFuture future) throws Exception {
92 public void onIncommingRpcSuccess() {
96 public void onIncommingRpcFail() {
100 public void onOutgoingRpcError() {
104 private static final String dateTimePatternString = DateAndTime.PATTERN_CONSTANTS.get(0);
105 private static final Pattern dateTimePattern = Pattern.compile(dateTimePatternString);
108 public Session toManagementSession() {
109 SessionBuilder builder = new SessionBuilder();
111 builder.setSessionId(getSessionId());
112 builder.setSourceHost(new Host(new DomainName(header.getAddress())));
114 Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
115 String formattedDateTime = dateFormatter.format(loginTime);
117 Matcher matcher = dateTimePattern.matcher(formattedDateTime);
118 Preconditions.checkState(matcher.matches(), "Formatted datetime %s does not match pattern %s", formattedDateTime, dateTimePattern);
119 builder.setLoginTime(new DateAndTime(formattedDateTime));
121 builder.setInBadRpcs(new ZeroBasedCounter32(inRpcFail));
122 builder.setInRpcs(new ZeroBasedCounter32(inRpcSuccess));
123 builder.setOutRpcErrors(new ZeroBasedCounter32(outRpcError));
125 builder.setUsername(header.getUserName());
126 builder.setTransport(getTransportForString(header.getTransport()));
128 builder.setOutNotifications(new ZeroBasedCounter32(0L));
130 builder.setKey(new SessionKey(getSessionId()));
132 Session1Builder builder1 = new Session1Builder();
133 builder1.setSessionIdentifier(header.getSessionIdentifier());
134 builder.addAugmentation(Session1.class, builder1.build());
136 return builder.build();
139 private static Class<? extends Transport> getTransportForString(final String transport) {
142 return NetconfSsh.class;
144 return NetconfTcp.class;
146 throw new IllegalArgumentException("Unknown transport type " + transport);
151 protected NetconfServerSession thisInstance() {
156 protected void addExiHandlers(final ByteToMessageDecoder decoder, final MessageToByteEncoder<NetconfMessage> encoder) {
157 replaceMessageDecoder(decoder);
158 replaceMessageEncoderAfterNextMessage(encoder);
162 public void stopExiCommunication() {
163 replaceMessageDecoder(new NetconfXMLToMessageDecoder());
164 replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());