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

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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 package org.opendaylight.netconf.nettyutil.handler.ssh.client;
   9
  10 import com.google.common.annotations.Beta;
  11 import io.netty.channel.ChannelHandlerContext;
  12 import io.netty.channel.ChannelPipeline;
  13 import java.io.IOException;
  14 import org.opendaylight.netconf.shaded.sshd.client.session.ClientSession;
  15
  16 /**
  17  * A {@link ClientSession} which additionally allows subsystem channels which are forwarded to a particular Netty
  18  * channel context.
  19  */
  20 @Beta
  21 public interface NettyAwareClientSession extends ClientSession {
  22     /**
  23      * Allocate a channel to the specified subsystem. Incoming data on the channel will be routed to the
  24      * specified {@link ChannelHandlerContext}.
  25      *
  26      * @param subsystem The subsystem name
  27      * @param ctx Context to which to route data to
  28      * @return The created {@link NettyAwareChannelSubsystem}
  29      * @throws IOException If failed to create the requested channel
  30      */
  31     NettyAwareChannelSubsystem createSubsystemChannel(String subsystem, ChannelHandlerContext ctx) throws IOException;
  32
  33     /**
  34      * Allocate a channel to the specified subsystem. Incoming data on the channel will be routed to the
  35      * specified {@link ChannelPipeline}.
  36      *
  37      * @param subsystem The subsystem name
  38      * @param pipeline ChannelPipeline to which to route data to
  39      * @return The created {@link NettyPipelineAwareChannelSubsystem}
  40      * @throws IOException If failed to create the requested channel
  41      */
  42     NettyPipelineAwareChannelSubsystem createSubsystemChannel(String subsystem, ChannelPipeline pipeline)
  43             throws IOException;
  44 }