opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/client/AsyncSshHandlerReader.java

   1 /*
   2  * Copyright (c) 2014 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.nettyutil.handler.ssh.client;
  10
  11 import io.netty.buffer.ByteBuf;
  12 import io.netty.buffer.Unpooled;
  13 import org.apache.sshd.common.future.SshFutureListener;
  14 import org.apache.sshd.common.io.IoInputStream;
  15 import org.apache.sshd.common.io.IoReadFuture;
  16 import org.apache.sshd.common.util.Buffer;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19
  20 /**
  21  * Listener on async input stream from SSH session.
  22  * This listeners schedules reads in a loop until the session is closed or read fails.
  23  */
  24 public final class AsyncSshHandlerReader implements SshFutureListener<IoReadFuture>, AutoCloseable {
  25
  26     private static final Logger logger = LoggerFactory.getLogger(AsyncSshHandler.class);
  27
  28     private static final int BUFFER_SIZE = 8192;
  29
  30     private final AutoCloseable connectionClosedCallback;
  31     private final ReadMsgHandler readHandler;
  32
  33     private final String channelId;
  34     private IoInputStream asyncOut;
  35     private Buffer buf;
  36     private IoReadFuture currentReadFuture;
  37
  38     public AsyncSshHandlerReader(final AutoCloseable connectionClosedCallback, final ReadMsgHandler readHandler, final String channelId, final IoInputStream asyncOut) {
  39         this.connectionClosedCallback = connectionClosedCallback;
  40         this.readHandler = readHandler;
  41         this.channelId = channelId;
  42         this.asyncOut = asyncOut;
  43         buf = new Buffer(BUFFER_SIZE);
  44         asyncOut.read(buf).addListener(this);
  45     }
  46
  47     @Override
  48     public synchronized void operationComplete(final IoReadFuture future) {
  49         if(future.getException() != null) {
  50             if(asyncOut.isClosed() || asyncOut.isClosing()) {
  51                 // Ssh dropped
  52                 logger.debug("Ssh session dropped on channel: {}", channelId, future.getException());
  53             } else {
  54                 logger.warn("Exception while reading from SSH remote on channel {}", channelId, future.getException());
  55             }
  56             invokeDisconnect();
  57             return;
  58         }
  59
  60         if (future.getRead() > 0) {
  61             final ByteBuf msg = Unpooled.wrappedBuffer(buf.array(), 0, future.getRead());
  62             if(logger.isTraceEnabled()) {
  63                 logger.trace("Reading message on channel: {}, message: {}", channelId, AsyncSshHandlerWriter.byteBufToString(msg));
  64             }
  65             readHandler.onMessageRead(msg);
  66
  67             // Schedule next read
  68             buf = new Buffer(BUFFER_SIZE);
  69             currentReadFuture = asyncOut.read(buf);
  70             currentReadFuture.addListener(this);
  71         }
  72     }
  73
  74     private void invokeDisconnect() {
  75         try {
  76             connectionClosedCallback.close();
  77         } catch (final Exception e) {
  78             // This should not happen
  79             throw new IllegalStateException(e);
  80         }
  81     }
  82
  83     @Override
  84     public synchronized void close() {
  85         // Remove self as listener on close to prevent reading from closed input
  86         if(currentReadFuture != null) {
  87             currentReadFuture.removeListener(this);
  88             currentReadFuture = null;
  89         }
  90
  91         asyncOut = null;
  92     }
  93
  94     public interface ReadMsgHandler {
  95
  96         void onMessageRead(ByteBuf msg);
  97     }
  98 }