X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2Fosgi%2FNetconfConfigUtil.java;h=c77e0d7da25dc112e54489fbae42bf317a3f2b3f;hp=38563cba93eef1f727330b17ff72879a012f70ff;hb=b3e553ce5b3d3e972cbe19465ab7af2fcb39934c;hpb=6fd408a04fe4a3611843e2246ece6d7c34b76903 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 38563cba93..c77e0d7da2 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,116 +9,103 @@ package org.opendaylight.controller.netconf.util.osgi; import com.google.common.base.Optional; +import io.netty.channel.local.LocalAddress; +import java.net.InetSocketAddress; import org.osgi.framework.BundleContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.net.InetSocketAddress; - -import static com.google.common.base.Preconditions.checkNotNull; - -public class NetconfConfigUtil { +public final class NetconfConfigUtil { private static final Logger logger = LoggerFactory.getLogger(NetconfConfigUtil.class); private static final String PREFIX_PROP = "netconf."; + private NetconfConfigUtil() { + } - - private enum InfixProp { + public enum InfixProp { tcp, ssh } private static final String PORT_SUFFIX_PROP = ".port"; 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 CONNECTION_TIMEOUT_MILLIS_PROP = "connectionTimeoutMillis"; private static final long DEFAULT_TIMEOUT_MILLIS = 5000; + private static final LocalAddress netconfLocalAddress = new LocalAddress("netconf"); - public static long extractTimeoutMillis(BundleContext bundleContext) { - String key = PREFIX_PROP + CONNECTION_TIMEOUT_MILLIS_PROP; - String timeoutString = bundleContext.getProperty(key); + public static LocalAddress getNetconfLocalAddress() { + return netconfLocalAddress; + } + + 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() == false) { - throw new IllegalStateException("Netconf tcp address not found." + exceptionMessageIfNotFound); - } - InetSocketAddress inetSocketAddress = inetSocketAddressOptional.get(); - if (inetSocketAddress.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; + public static String getPrivateKeyPath(final BundleContext context) { + return getPropertyValue(context, getPrivateKeyKey()); } - public static Optional extractSSHNetconfAddress(BundleContext context, String exceptionMessage) { - return extractSomeNetconfAddress(context, InfixProp.ssh, exceptionMessage, false); + public static String getPrivateKeyKey() { + return PREFIX_PROP + InfixProp.ssh + PRIVATE_KEY_PATH_PROP; } - public static String getPrivateKeyPath(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; } + + public static String getNetconfServerAddressKey(InfixProp infixProp) { + return PREFIX_PROP + infixProp + ADDRESS_SUFFIX_PROP; + } + /** - * @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; + public static Optional extractNetconfServerAddress(final BundleContext context, + final InfixProp infixProp) { + + final Optional address = getProperty(context, getNetconfServerAddressKey(infixProp)); + 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; - } - 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 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 getProperty(final BundleContext context, final String propKey) { + String value = context.getProperty(propKey); + if (value != null && value.isEmpty()) { + value = null; } + return Optional.fromNullable(value); } }