netconf/callhome-protocol/src/main/java/org/opendaylight/netconf/callhome/protocol/CallHomeChannelActivator.java

   1 /*
   2  * Copyright (c) 2016 Brocade Communication Systems 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.callhome.protocol;
   9
  10 import io.netty.util.concurrent.Promise;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.netconf.client.NetconfClientSession;
  13 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  14
  15 /**
  16  * Activator of NETCONF channel on incoming SSH Call Home session.
  17  *
  18  */
  19 public interface CallHomeChannelActivator {
  20
  21     /**
  22      *
  23      * Activates Netconf Client Channel with supplied client session listener.
  24      *
  25      * Activation of channel will result in start of NETCONF client
  26      * session negotiation on underlying ssh channel.
  27      *
  28      * @param listener Client Session Listener to be attached to NETCONF session.
  29      * @return Promise with negotiated NETCONF session
  30      */
  31     @Nonnull
  32     Promise<NetconfClientSession> activate(@Nonnull NetconfClientSessionListener listener);
  33
  34 }