netconf/callhome-protocol/src/main/java/org/opendaylight/netconf/callhome/protocol/CallHomeNetconfSubsystemListener.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 org.opendaylight.netconf.client.NetconfClientSessionListener;
  11
  12 /**
  13  * Listener for successful opening of NETCONF channel on incoming Call Home connections.
  14  */
  15 public interface CallHomeNetconfSubsystemListener {
  16     /**
  17      * Invoked when Netconf Subsystem was successfully opened on incoming SSH Call Home connection.
  18      * <p>
  19      * Implementors of this method should use provided {@link CallHomeChannelActivator} to attach
  20      * {@link NetconfClientSessionListener} to session and to start NETCONF client session negotiation.
  21      *
  22      * @param session   Incoming Call Home session on which NETCONF subsystem was successfully opened
  23      * @param activator Channel Activator to be used in order to start NETCONF Session negotiation.
  24      */
  25     void onNetconfSubsystemOpened(CallHomeProtocolSessionContext session, CallHomeChannelActivator activator);
  26 }