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 com.google.common.util.concurrent.ListenableFuture;
  11 import org.eclipse.jdt.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 public interface CallHomeChannelActivator {
  19     /**
  20      * Activates Netconf Client Channel with supplied client session listener.
  21      *
  22      * <p>
  23      * Activation of channel will result in start of NETCONF client
  24      * session negotiation on underlying ssh channel.
  25      *
  26      * @param listener Client Session Listener to be attached to NETCONF session.
  27      * @return Future with negotiated NETCONF session
  28      */
  29     @NonNull ListenableFuture<NetconfClientSession> activate(@NonNull NetconfClientSessionListener listener);
  30 }