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.handler.codec.ByteToMessageDecoder;
  14 import io.netty.handler.codec.MessageToByteEncoder;
  15 import java.text.SimpleDateFormat;
  16 import java.util.Date;
  17 import java.util.regex.Matcher;
  18 import java.util.regex.Pattern;
  19 import org.opendaylight.controller.netconf.api.NetconfMessage;
  20 import org.opendaylight.controller.netconf.api.monitoring.NetconfManagementSession;
  21 import org.opendaylight.controller.netconf.nettyutil.AbstractNetconfSession;
  22 import org.opendaylight.controller.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
  23 import org.opendaylight.controller.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
  24 import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessageAdditionalHeader;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.DomainName;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.NetconfTcp;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.extension.rev131210.Session1Builder;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionKey;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.DateAndTime;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.ZeroBasedCounter32;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession, NetconfServerSessionListener> implements NetconfManagementSession {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
  43
  44     private final NetconfHelloMessageAdditionalHeader header;
  45
  46     private Date loginTime;
  47     private long inRpcSuccess, inRpcFail, outRpcError;
  48
  49     public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel, final long sessionId,
  50             final NetconfHelloMessageAdditionalHeader header) {
  51         super(sessionListener, channel, sessionId);
  52         this.header = header;
  53         LOG.debug("Session {} created", toString());
  54     }
  55
  56     @Override
  57     protected void sessionUp() {
  58         Preconditions.checkState(loginTime == null, "Session is already up");
  59         this.loginTime = new Date();
  60         super.sessionUp();
  61     }
  62
  63     public void onIncommingRpcSuccess() {
  64         inRpcSuccess++;
  65     }
  66
  67     public void onIncommingRpcFail() {
  68         inRpcFail++;
  69     }
  70
  71     public void onOutgoingRpcError() {
  72         outRpcError++;
  73     }
  74
  75     public static final String ISO_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
  76
  77     private static final String dateTimePatternString = DateAndTime.PATTERN_CONSTANTS.get(0);
  78     private static final Pattern dateTimePattern = Pattern.compile(dateTimePatternString);
  79
  80     @Override
  81     public Session toManagementSession() {
  82         SessionBuilder builder = new SessionBuilder();
  83
  84         builder.setSessionId(getSessionId());
  85         builder.setSourceHost(new Host(new DomainName(header.getAddress())));
  86
  87         Preconditions.checkState(DateAndTime.PATTERN_CONSTANTS.size() == 1);
  88         String formattedDateTime = formatDateTime(loginTime);
  89
  90         Matcher matcher = dateTimePattern.matcher(formattedDateTime);
  91         Preconditions.checkState(matcher.matches(), "Formatted datetime %s does not match pattern %s", formattedDateTime, dateTimePattern);
  92         builder.setLoginTime(new DateAndTime(formattedDateTime));
  93
  94         builder.setInBadRpcs(new ZeroBasedCounter32(inRpcFail));
  95         builder.setInRpcs(new ZeroBasedCounter32(inRpcSuccess));
  96         builder.setOutRpcErrors(new ZeroBasedCounter32(outRpcError));
  97
  98         builder.setUsername(header.getUserName());
  99         builder.setTransport(getTransportForString(header.getTransport()));
 100
 101         builder.setOutNotifications(new ZeroBasedCounter32(0L));
 102
 103         builder.setKey(new SessionKey(getSessionId()));
 104
 105         Session1Builder builder1 = new Session1Builder();
 106         builder1.setSessionIdentifier(header.getSessionIdentifier());
 107         builder.addAugmentation(Session1.class, builder1.build());
 108
 109         return builder.build();
 110     }
 111
 112     private Class<? extends Transport> getTransportForString(final String transport) {
 113         switch(transport) {
 114         case "ssh" :
 115             return NetconfSsh.class;
 116         case "tcp" :
 117             return NetconfTcp.class;
 118         default:
 119             throw new IllegalArgumentException("Unknown transport type " + transport);
 120         }
 121     }
 122
 123     private String formatDateTime(final Date loginTime) {
 124         SimpleDateFormat dateFormat = new SimpleDateFormat(ISO_DATE_FORMAT);
 125         return dateFormat.format(loginTime);
 126     }
 127
 128     @Override
 129     protected NetconfServerSession thisInstance() {
 130         return this;
 131     }
 132
 133     @Override
 134     protected void addExiHandlers(final ByteToMessageDecoder decoder, final MessageToByteEncoder<NetconfMessage> encoder) {
 135         replaceMessageDecoder(decoder);
 136         replaceMessageEncoderAfterNextMessage(encoder);
 137     }
 138
 139     @Override
 140     public void stopExiCommunication() {
 141         replaceMessageDecoder(new NetconfXMLToMessageDecoder());
 142         replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());
 143     }
 144 }