netconf/callhome-protocol/src/main/java/org/opendaylight/netconf/callhome/protocol/CallHomeProtocolSessionContext.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 java.net.SocketAddress;
  11 import java.security.PublicKey;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.connection.parameters.Protocol.Name;
  13
  14 /**
  15  * Protocol level Session Context for incoming Call Home connections.
  16  */
  17 public interface CallHomeProtocolSessionContext {
  18
  19     /**
  20      * Returns session identifier provided by  CallHomeAuthorizationProvider.
  21      *
  22      * @return Returns application-provided session identifier
  23      */
  24     String getSessionId();
  25
  26     /**
  27      * Returns public key provided by remote SSH Server for this session.
  28      *
  29      * @return public key provided by remote SSH Server
  30      */
  31     PublicKey getRemoteServerKey();
  32
  33     /**
  34      * Returns remote socket address associated with this session.
  35      *
  36      * @return remote socket address associated with this session.
  37      */
  38     SocketAddress getRemoteAddress();
  39
  40     /**
  41      * Terminate this session.
  42      */
  43     void terminate();
  44
  45     /**
  46      * Returns transport type for this session.
  47      *
  48      * @return {@link Name} for this session.
  49      */
  50     Name getTransportType();
  51 }