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