netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/NetconfServerSession.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.impl;
  10
  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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.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.rev100924.DateAndTime;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.ZeroBasedCounter32;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession, NetconfServerSessionListener> implements NetconfManagementSession {
  50
  51     private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
  52     private static final DateTimeFormatter dateFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
  53
  54     private final NetconfHelloMessageAdditionalHeader header;
  55
  56     private ZonedDateTime loginTime;
  57     private long inRpcSuccess, inRpcFail, outRpcError;
  58     private volatile boolean delayedClose;
  59
  60     public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel, final long sessionId,
  61             final NetconfHelloMessageAdditionalHeader header) {
  62         super(sessionListener, channel, sessionId);
  63         this.header = header;
  64         LOG.debug("Session {} created", toString());
  65     }
  66
  67     @Override
  68     protected void sessionUp() {
  69         Preconditions.checkState(loginTime == null, "Session is already up");
  70         this.loginTime = Instant.now().atZone(ZoneId.systemDefault());
  71         super.sessionUp();
  72     }
  73
  74     /**
  75      * Close this session after next message is sent.
  76      * Suitable for close rpc that needs to send ok response before the session is closed.
  77      */
  78     public void delayedClose() {
  79         this.delayedClose = true;
  80     }
  81
  82     @Override
  83     public ChannelFuture sendMessage(final NetconfMessage netconfMessage) {
  84         final ChannelFuture channelFuture = super.sendMessage(netconfMessage);
  85         // delayed close was set, close after the message was sent
  86         if(delayedClose) {
  87             channelFuture.addListener(new ChannelFutureListener() {
  88                 @Override
  89                 public void operationComplete(final ChannelFuture future) throws Exception {
  90                     close();
  91                 }
  92             });
  93         }
  94         return channelFuture;
  95     }
  96
  97     public void onIncommingRpcSuccess() {
  98         inRpcSuccess++;
  99     }
 100
 101     public void onIncommingRpcFail() {
 102         inRpcFail++;
 103     }
 104
 105     public void onOutgoingRpcError() {
 106         outRpcError++;
 107     }
 108
 109     private static final String dateTimePatternString = DateAndTime.PATTERN_CONSTANTS.get(0);
 110     private static final Pattern dateTimePattern = Pattern.compile(dateTimePatternString);
 111
 112     @Override
 113     public Session toManagementSession() {
 114         SessionBuilder builder = new SessionBuilder();
 115
 116         builder.setSessionId(getSessionId());
 117         IpAddress address;
 118         InetAddress address1 = InetAddresses.forString(header.getAddress());
 119         if (address1 instanceof Inet4Address) {
 120             address = new IpAddress(new Ipv4Address(header.getAddress()));
 121         } else {
 122             address = new IpAddress(new Ipv6Address(header.getAddress()));
 123         }
 124         builder.setSourceHost(new Host(address));
 125
 126         Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
 127         String formattedDateTime = dateFormatter.format(loginTime);
 128
 129         Matcher matcher = dateTimePattern.matcher(formattedDateTime);
 130         Preconditions.checkState(matcher.matches(), "Formatted datetime %s does not match pattern %s", formattedDateTime, dateTimePattern);
 131         builder.setLoginTime(new DateAndTime(formattedDateTime));
 132
 133         builder.setInBadRpcs(new ZeroBasedCounter32(inRpcFail));
 134         builder.setInRpcs(new ZeroBasedCounter32(inRpcSuccess));
 135         builder.setOutRpcErrors(new ZeroBasedCounter32(outRpcError));
 136
 137         builder.setUsername(header.getUserName());
 138         builder.setTransport(getTransportForString(header.getTransport()));
 139
 140         builder.setOutNotifications(new ZeroBasedCounter32(0L));
 141
 142         builder.setKey(new SessionKey(getSessionId()));
 143
 144         Session1Builder builder1 = new Session1Builder();
 145         builder1.setSessionIdentifier(header.getSessionIdentifier());
 146         builder.addAugmentation(Session1.class, builder1.build());
 147
 148         return builder.build();
 149     }
 150
 151     private static Class<? extends Transport> getTransportForString(final String transport) {
 152         switch(transport) {
 153         case "ssh" :
 154             return NetconfSsh.class;
 155         case "tcp" :
 156             return NetconfTcp.class;
 157         default:
 158             throw new IllegalArgumentException("Unknown transport type " + transport);
 159         }
 160     }
 161
 162     @Override
 163     protected NetconfServerSession thisInstance() {
 164         return this;
 165     }
 166
 167     @Override
 168     protected void addExiHandlers(final ByteToMessageDecoder decoder, final MessageToByteEncoder<NetconfMessage> encoder) {
 169         replaceMessageDecoder(decoder);
 170         replaceMessageEncoderAfterNextMessage(encoder);
 171     }
 172
 173     @Override
 174     public void stopExiCommunication() {
 175         replaceMessageDecoder(new NetconfXMLToMessageDecoder());
 176         replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());
 177     }
 178 }