2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.netconf.util.osgi;
11 import com.google.common.base.Optional;
12 import io.netty.channel.local.LocalAddress;
13 import java.net.InetSocketAddress;
14 import org.osgi.framework.BundleContext;
15 import org.slf4j.Logger;
16 import org.slf4j.LoggerFactory;
18 public final class NetconfConfigUtil {
19 private static final Logger LOG = LoggerFactory.getLogger(NetconfConfigUtil.class);
21 private static final String PREFIX_PROP = "netconf.";
23 private NetconfConfigUtil() {
26 public enum InfixProp {
30 private static final String PORT_SUFFIX_PROP = ".port";
31 private static final String ADDRESS_SUFFIX_PROP = ".address";
32 private static final String PRIVATE_KEY_PATH_PROP = ".pk.path";
34 private static final String CONNECTION_TIMEOUT_MILLIS_PROP = "connectionTimeoutMillis";
35 private static final long DEFAULT_TIMEOUT_MILLIS = 5000;
36 private static final LocalAddress netconfLocalAddress = new LocalAddress("netconf");
38 public static LocalAddress getNetconfLocalAddress() {
39 return netconfLocalAddress;
42 public static long extractTimeoutMillis(final BundleContext bundleContext) {
43 final String key = PREFIX_PROP + CONNECTION_TIMEOUT_MILLIS_PROP;
44 final String timeoutString = bundleContext.getProperty(key);
45 if (timeoutString == null || timeoutString.length() == 0) {
46 return DEFAULT_TIMEOUT_MILLIS;
49 return Long.parseLong(timeoutString);
50 } catch (final NumberFormatException e) {
51 LOG.warn("Cannot parse {} property: {}, using defaults", key, timeoutString, e);
52 return DEFAULT_TIMEOUT_MILLIS;
56 public static String getPrivateKeyPath(final BundleContext context) {
57 return getPropertyValue(context, getPrivateKeyKey());
60 public static String getPrivateKeyKey() {
61 return PREFIX_PROP + InfixProp.ssh + PRIVATE_KEY_PATH_PROP;
64 private static String getPropertyValue(final BundleContext context, final String propertyName) {
65 final String propertyValue = context.getProperty(propertyName);
66 if (propertyValue == null) {
67 throw new IllegalStateException("Cannot find initial property with name '" + propertyName + "'");
72 public static String getNetconfServerAddressKey(InfixProp infixProp) {
73 return PREFIX_PROP + infixProp + ADDRESS_SUFFIX_PROP;
77 * @param context from which properties are being read.
78 * @param infixProp either tcp or ssh
79 * @return value if address and port are present and valid, Optional.absent otherwise.
80 * @throws IllegalStateException if address or port are invalid, or configuration is missing
82 public static Optional<InetSocketAddress> extractNetconfServerAddress(final BundleContext context,
83 final InfixProp infixProp) {
85 final Optional<String> address = getProperty(context, getNetconfServerAddressKey(infixProp));
86 final Optional<String> port = getProperty(context, PREFIX_PROP + infixProp + PORT_SUFFIX_PROP);
88 if (address.isPresent() && port.isPresent()) {
90 return Optional.of(parseAddress(address, port));
91 } catch (final RuntimeException e) {
92 LOG.warn("Unable to parse {} netconf address from {}:{}, fallback to default",
93 infixProp, address, port, e);
96 return Optional.absent();
99 private static InetSocketAddress parseAddress(final Optional<String> address, final Optional<String> port) {
100 final int portNumber = Integer.valueOf(port.get());
101 return new InetSocketAddress(address.get(), portNumber);
104 private static Optional<String> getProperty(final BundleContext context, final String propKey) {
105 String value = context.getProperty(propKey);
106 if (value != null && value.isEmpty()) {
109 return Optional.fromNullable(value);