X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2Fosgi%2FNetconfConfigUtil.java;fp=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2Fosgi%2FNetconfConfigUtil.java;h=0993b8ad0c7038e5b86b0fee0e5cb4d30fd701f8;hb=d8cb12ba12932c5b418a4fcaf814b42b439c486c;hp=f89df2ac7cc331908f64ed8d05b2dc826f4d7757;hpb=2107a0dea241ea8ffce8a2950a5e6b5799dcda66;p=controller.git diff --git a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/osgi/NetconfConfigUtil.java b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/osgi/NetconfConfigUtil.java index f89df2ac7c..0993b8ad0c 100644 --- a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/osgi/NetconfConfigUtil.java +++ b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/osgi/NetconfConfigUtil.java @@ -9,19 +9,24 @@ package org.opendaylight.controller.netconf.util.osgi; import com.google.common.base.Optional; -import com.google.common.base.Strings; -import java.net.InetSocketAddress; import org.osgi.framework.BundleContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import static com.google.common.base.Preconditions.checkNotNull; + +import java.net.InetSocketAddress; public final class NetconfConfigUtil { private static final Logger logger = LoggerFactory.getLogger(NetconfConfigUtil.class); + public static final InetSocketAddress DEFAULT_NETCONF_TCP_ADDRESS + = new InetSocketAddress("127.0.0.1", 8383); + public static final InetSocketAddress DEFAULT_NETCONF_SSH_ADDRESS + = new InetSocketAddress("0.0.0.0", 1830); + private static final String PREFIX_PROP = "netconf."; - private NetconfConfigUtil() {} + private NetconfConfigUtil() { + } private enum InfixProp { tcp, ssh @@ -31,109 +36,133 @@ public final class NetconfConfigUtil { private static final String ADDRESS_SUFFIX_PROP = ".address"; private static final String CLIENT_PROP = ".client"; private static final String PRIVATE_KEY_PATH_PROP = ".pk.path"; - private static final String SSH_DEFAULT_USER = ".default.user"; - private static final String SSH_DEFAULT_PASSWORD = ".default.password"; private static final String CONNECTION_TIMEOUT_MILLIS_PROP = "connectionTimeoutMillis"; private static final long DEFAULT_TIMEOUT_MILLIS = 5000; - public static long extractTimeoutMillis(BundleContext bundleContext) { - String key = PREFIX_PROP + CONNECTION_TIMEOUT_MILLIS_PROP; - String timeoutString = bundleContext.getProperty(key); + public static long extractTimeoutMillis(final BundleContext bundleContext) { + final String key = PREFIX_PROP + CONNECTION_TIMEOUT_MILLIS_PROP; + final String timeoutString = bundleContext.getProperty(key); if (timeoutString == null || timeoutString.length() == 0) { return DEFAULT_TIMEOUT_MILLIS; } try { return Long.parseLong(timeoutString); - }catch(NumberFormatException e) { + } catch (final NumberFormatException e) { logger.warn("Cannot parse {} property: {}, using defaults", key, timeoutString, e); return DEFAULT_TIMEOUT_MILLIS; } } - public static InetSocketAddress extractTCPNetconfAddress(BundleContext context, String exceptionMessageIfNotFound, boolean forClient) { - - Optional inetSocketAddressOptional = extractSomeNetconfAddress(context, InfixProp.tcp, exceptionMessageIfNotFound, forClient); - - if (!inetSocketAddressOptional.isPresent()) { - throw new IllegalStateException("Netconf tcp address not found." + exceptionMessageIfNotFound); - } - InetSocketAddress inetSocketAddress = inetSocketAddressOptional.get(); - if (inetSocketAddress.getAddress().isAnyLocalAddress()) { + public static InetSocketAddress extractTCPNetconfServerAddress(final BundleContext context, final InetSocketAddress defaultAddress) { + final Optional extracted = extractNetconfServerAddress(context, InfixProp.tcp); + final InetSocketAddress netconfTcpAddress = getNetconfAddress(defaultAddress, extracted, InfixProp.tcp); + logger.debug("Using {} as netconf tcp address", netconfTcpAddress); + if (netconfTcpAddress.getAddress().isAnyLocalAddress()) { logger.warn("Unprotected netconf TCP address is configured to ANY local address. This is a security risk. " + "Consider changing {} to 127.0.0.1", PREFIX_PROP + InfixProp.tcp + ADDRESS_SUFFIX_PROP); } - return inetSocketAddress; + return netconfTcpAddress; } - public static Optional extractSSHNetconfAddress(BundleContext context, String exceptionMessage) { - return extractSomeNetconfAddress(context, InfixProp.ssh, exceptionMessage, false); + public static InetSocketAddress extractTCPNetconfClientAddress(final BundleContext context, final InetSocketAddress defaultAddress) { + final Optional extracted = extractNetconfClientAddress(context, InfixProp.tcp); + return getNetconfAddress(defaultAddress, extracted, InfixProp.tcp); } - public static String getPrivateKeyPath(BundleContext context){ - return getPropertyValue(context,PREFIX_PROP + InfixProp.ssh +PRIVATE_KEY_PATH_PROP); + /** + * Get extracted address or default. + * + * @throws java.lang.IllegalStateException if neither address is present. + */ + private static InetSocketAddress getNetconfAddress(final InetSocketAddress defaultAddress, Optional extractedAddress, InfixProp infix) { + InetSocketAddress inetSocketAddress; + + if (extractedAddress.isPresent() == false) { + logger.debug("Netconf {} address not found, falling back to default {}", infix, defaultAddress); + + if (defaultAddress == null) { + logger.warn("Netconf {} address not found, default address not provided", infix); + throw new IllegalStateException("Netconf " + infix + " address not found, default address not provided"); + } + inetSocketAddress = defaultAddress; + } else { + inetSocketAddress = extractedAddress.get(); + } + + return inetSocketAddress; } - public static Optional getSSHDefaultUser(BundleContext context){ - return getOptionalPropertyValue(context,PREFIX_PROP + InfixProp.ssh +SSH_DEFAULT_USER); + + public static InetSocketAddress extractSSHNetconfAddress(final BundleContext context, final InetSocketAddress defaultAddress) { + Optional extractedAddress = extractNetconfServerAddress(context, InfixProp.ssh); + InetSocketAddress netconfSSHAddress = getNetconfAddress(defaultAddress, extractedAddress, InfixProp.ssh); + logger.debug("Using {} as netconf SSH address", netconfSSHAddress); + return netconfSSHAddress; } - public static Optional getSSHDefaultPassword(BundleContext context){ - return getOptionalPropertyValue(context,PREFIX_PROP + InfixProp.ssh +SSH_DEFAULT_PASSWORD); + + public static String getPrivateKeyPath(final BundleContext context) { + return getPropertyValue(context, PREFIX_PROP + InfixProp.ssh + PRIVATE_KEY_PATH_PROP); } - private static String getPropertyValue(BundleContext context, String propertyName){ - String propertyValue = context.getProperty(propertyName); - if (propertyValue == null){ - throw new IllegalStateException("Cannot find initial property with name '"+propertyName+"'"); + private static String getPropertyValue(final BundleContext context, final String propertyName) { + final String propertyValue = context.getProperty(propertyName); + if (propertyValue == null) { + throw new IllegalStateException("Cannot find initial property with name '" + propertyName + "'"); } return propertyValue; } - private static Optional getOptionalPropertyValue(BundleContext context, String propertyName){ - String propertyValue = context.getProperty(propertyName); - if (Strings.isNullOrEmpty(propertyValue)){ - return Optional.absent(); - } - return Optional.fromNullable(propertyValue); - } + /** - * @param context - * from which properties are being read. - * @param infixProp - * either tcp or ssh - * @return value if address and port are valid. - * @throws IllegalStateException - * if address or port are invalid, or configuration is missing + * @param context from which properties are being read. + * @param infixProp either tcp or ssh + * @return value if address and port are present and valid, Optional.absent otherwise. + * @throws IllegalStateException if address or port are invalid, or configuration is missing */ - private static Optional extractSomeNetconfAddress(BundleContext context, - InfixProp infixProp, - String exceptionMessage, - boolean client) { - String address = ""; - if (client) { - address = context.getProperty(PREFIX_PROP + infixProp + CLIENT_PROP + ADDRESS_SUFFIX_PROP); - } - if (address == null || address.equals("")){ - address = context.getProperty(PREFIX_PROP + infixProp + ADDRESS_SUFFIX_PROP); - } - if (address == null || address.equals("")) { - throw new IllegalStateException("Cannot find initial netconf configuration for parameter " - +PREFIX_PROP + infixProp + ADDRESS_SUFFIX_PROP - +" in config.ini. "+exceptionMessage); - } - String portKey = ""; - if (client) { - portKey = PREFIX_PROP + infixProp + CLIENT_PROP + PORT_SUFFIX_PROP; + private static Optional extractNetconfServerAddress(final BundleContext context, + final InfixProp infixProp) { + + final Optional address = getProperty(context, PREFIX_PROP + infixProp + ADDRESS_SUFFIX_PROP); + final Optional port = getProperty(context, PREFIX_PROP + infixProp + PORT_SUFFIX_PROP); + + if (address.isPresent() && port.isPresent()) { + try { + return Optional.of(parseAddress(address, port)); + } catch (final RuntimeException e) { + logger.warn("Unable to parse {} netconf address from {}:{}, fallback to default", + infixProp, address, port, e); + } } - if (portKey == null || portKey.equals("")){ - portKey = PREFIX_PROP + infixProp + PORT_SUFFIX_PROP; + return Optional.absent(); + } + + private static InetSocketAddress parseAddress(final Optional address, final Optional port) { + final int portNumber = Integer.valueOf(port.get()); + return new InetSocketAddress(address.get(), portNumber); + } + + private static Optional extractNetconfClientAddress(final BundleContext context, + final InfixProp infixProp) { + final Optional address = getProperty(context, + PREFIX_PROP + infixProp + CLIENT_PROP + ADDRESS_SUFFIX_PROP); + final Optional port = getProperty(context, + PREFIX_PROP + infixProp + CLIENT_PROP + PORT_SUFFIX_PROP); + + if (address.isPresent() && port.isPresent()) { + try { + return Optional.of(parseAddress(address, port)); + } catch (final RuntimeException e) { + logger.warn("Unable to parse client {} netconf address from {}:{}, fallback to server address", + infixProp, address, port, e); + } } - String portString = context.getProperty(portKey); - checkNotNull(portString, "Netconf port must be specified in properties file with " + portKey); - try { - int port = Integer.valueOf(portString); - return Optional.of(new InetSocketAddress(address, port)); - } catch (RuntimeException e) { - throw new IllegalStateException("Cannot create " + infixProp + " netconf address from address:" + address - + " and port:" + portString, e); + return extractNetconfServerAddress(context, infixProp); + } + + private static Optional getProperty(final BundleContext context, final String propKey) { + String value = context.getProperty(propKey); + if (value != null && value.isEmpty()) { + value = null; } + return Optional.fromNullable(value); } }