netconf/netconf-util/src/main/java/org/opendaylight/netconf/util/NetconfConfiguration.java

   1 /*
   2  * Copyright (c) 2017 Inocybe Technologies 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
   9 package org.opendaylight.netconf.util;
  10
  11 import io.netty.channel.local.LocalAddress;
  12 import java.net.InetSocketAddress;
  13 import java.util.concurrent.TimeUnit;
  14
  15 /**
  16  * Configuration for NETCONF northbound.
  17  */
  18 public interface NetconfConfiguration {
  19
  20     /**
  21      * LocalAddress constant for NETCONF northbound.
  22      */
  23     LocalAddress NETCONF_LOCAL_ADDRESS = new LocalAddress("netconf");
  24
  25     /**
  26      * Default timeout for NETCONF northbound connections.
  27      */
  28     long DEFAULT_TIMEOUT_MILLIS = TimeUnit.SECONDS.toMillis(30);
  29
  30     /**
  31      * NETCONF SSH server address.
  32      *
  33      * @return NETCONF SSH server address
  34      */
  35     InetSocketAddress getSshServerAddress();
  36
  37     /**
  38      * NETCONF TCP server address.
  39      *
  40      * @return NETCONF TCP server address.
  41      */
  42     InetSocketAddress getTcpServerAddress();
  43
  44     /**
  45      * Private key path for NETCONF.
  46      *
  47      * @return Private key path for NETCONF.
  48      */
  49     String getPrivateKeyPath();
  50 }