Inline NetconfServerSessionNegotiatorFactoryBuilder

Make the builder static inline class for the entity being built,
cleaning up the namespace a bit. This allows us to inline
transformCapabilities(), as it is only used in the builder.

JIRA: NETCONF-1106
Change-Id: Id22438e6212188f19c85ccb74d9d0d5077c2c84c
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/apps/netconf-nb/src/main/java/org/opendaylight/netconf/northbound/OSGiNetconfServer.java b/apps/netconf-nb/src/main/java/org/opendaylight/netconf/northbound/OSGiNetconfServer.java
index c89f62f9c574da3cce40448f86c3fc98c4837f44..d01ff407cd3493dd198532388c504733987132c1 100644 (file)
--- a/apps/netconf-nb/src/main/java/org/opendaylight/netconf/northbound/OSGiNetconfServer.java
+++ b/apps/netconf-nb/src/main/java/org/opendaylight/netconf/northbound/OSGiNetconfServer.java
@@ -58,8 +58,13 @@ public final class OSGiNetconfServer {
         mappers.onAddNetconfOperationServiceFactory(mapperAggregatorRegistry);
         monitoring = monitoringFactory.newInstance(FrameworkUtil.asDictionary(DefaultNetconfMonitoringService.props(
             mapperAggregatorRegistry, sshScheduledExecutor, configuration.monitoring$_$update$_$interval())));
-        serverTransportInitializer = new ServerTransportInitializer(new NetconfServerSessionNegotiatorFactory(timer,
-            mappers, sessionIdProvider, configuration.connection$_$timeout$_$millis(), monitoring.getInstance()));
+        serverTransportInitializer = new ServerTransportInitializer(NetconfServerSessionNegotiatorFactory.builder()
+            .setTimer(timer)
+            .setAggregatedOpService(mappers)
+            .setIdProvider(sessionIdProvider)
+            .setConnectionTimeoutMillis(configuration.connection$_$timeout$_$millis())
+            .setMonitoringService(monitoring.getInstance())
+            .build());
     }
 
     @Deactivate

diff --git a/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java b/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java
index 19c1a191733e3eefeea81fa7b52fd84ab5bcb354..444533c3caaa0afebe5909dcbacd291101136ff1 100644 (file)
--- a/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java
+++ b/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java
@@ -7,14 +7,19 @@
  */
 package org.opendaylight.netconf.server;
 
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Sets;
 import io.netty.channel.Channel;
 import io.netty.util.Timer;
 import io.netty.util.concurrent.Promise;
 import java.net.SocketAddress;
+import java.util.HashSet;
 import java.util.Set;
 import org.checkerframework.checker.index.qual.NonNegative;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.netconf.api.CapabilityURN;
 import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
@@ -24,8 +29,6 @@ import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
 import org.opendaylight.netconf.server.osgi.NetconfOperationRouterImpl;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
 
 // non-final for testing and netconf-testtool (for some reason)
 public class NetconfServerSessionNegotiatorFactory {
@@ -43,15 +46,7 @@ public class NetconfServerSessionNegotiatorFactory {
     private final NetconfMonitoringService monitoringService;
     private final Set<String> baseCapabilities;
 
-    // FIXME: 5.0.0: protected
-    public NetconfServerSessionNegotiatorFactory(final Timer timer,
-            final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
-            final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService) {
-        this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, null);
-    }
-
-    // FIXME: 5.0.0: protected
-    public NetconfServerSessionNegotiatorFactory(final Timer timer,
+    protected NetconfServerSessionNegotiatorFactory(final Timer timer,
             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
             final long connectionTimeoutMillis,  final NetconfMonitoringService monitoringService,
             final Set<String> baseCapabilities) {
@@ -59,7 +54,7 @@ public class NetconfServerSessionNegotiatorFactory {
             NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
     }
 
-    protected NetconfServerSessionNegotiatorFactory(final Timer timer,
+    private NetconfServerSessionNegotiatorFactory(final Timer timer,
             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
             final Set<String> baseCapabilities, final @NonNegative int maximumIncomingChunkSize) {
@@ -89,6 +84,10 @@ public class NetconfServerSessionNegotiatorFactory {
             .build();
     }
 
+    public static @NonNull Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Get session negotiator.
      *
@@ -101,9 +100,13 @@ public class NetconfServerSessionNegotiatorFactory {
         final var sessionId = idProvider.getNextSessionId();
         final var service = getOperationServiceForAddress(sessionId,
             channel.parent() == null ? null : channel.parent().localAddress());
+        final var capabilities = new HashSet<>(baseCapabilities);
+        for (var capability : monitoringService.getCapabilities().requireCapability()) {
+            capabilities.add(capability.getValue());
+        }
 
-        return new NetconfServerSessionNegotiator(createHelloMessage(sessionId, monitoringService), sessionId, promise,
-            channel, timer,
+        return new NetconfServerSessionNegotiator(HelloMessage.createServerHello(capabilities, sessionId), sessionId,
+            promise, channel, timer,
             new NetconfServerSessionListener(new NetconfOperationRouterImpl(service, monitoringService, sessionId),
                 monitoringService, service),
             connectionTimeoutMillis, maximumIncomingChunkSize);
@@ -118,14 +121,74 @@ public class NetconfServerSessionNegotiatorFactory {
         return aggregatedOpService;
     }
 
-    private HelloMessage createHelloMessage(final SessionIdType sessionId,
-            final NetconfMonitoringService capabilityProvider) {
-        return HelloMessage.createServerHello(Sets.union(
-            transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities),
-            sessionId);
-    }
+    public static final class Builder {
+        private @NonNegative int maximumIncomingChunkSize =
+            NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
+        private Timer timer;
+        private SessionIdProvider idProvider;
+        private NetconfOperationServiceFactory aggregatedOpService;
+        private long connectionTimeoutMillis;
+        private NetconfMonitoringService monitoringService;
+        private Set<String> baseCapabilities;
+
+        private Builder() {
+            // Hidden on purpose
+        }
+
+        public Builder setTimer(final Timer timer) {
+            this.timer = timer;
+            return this;
+        }
+
+        public Builder setIdProvider(final SessionIdProvider idProvider) {
+            this.idProvider = idProvider;
+            return this;
+        }
+
+        public Builder setAggregatedOpService(
+                final NetconfOperationServiceFactory aggregatedOpService) {
+            this.aggregatedOpService = aggregatedOpService;
+            return this;
+        }
+
+        public Builder setConnectionTimeoutMillis(final long connectionTimeoutMillis) {
+            this.connectionTimeoutMillis = connectionTimeoutMillis;
+            return this;
+        }
+
+        public Builder setMonitoringService(
+                final NetconfMonitoringService monitoringService) {
+            this.monitoringService = monitoringService;
+            return this;
+        }
 
-    public static ImmutableSet<String> transformCapabilities(final Capabilities capabilities) {
-        return capabilities.requireCapability().stream().map(Uri::getValue).collect(ImmutableSet.toImmutableSet());
+        public Builder setBaseCapabilities(final Set<String> baseCapabilities) {
+            this.baseCapabilities = baseCapabilities;
+            return this;
+        }
+
+        public Builder setMaximumIncomingChunkSize(final @NonNegative int maximumIncomingChunkSize) {
+            checkArgument(maximumIncomingChunkSize > 0);
+            this.maximumIncomingChunkSize = maximumIncomingChunkSize;
+            return this;
+        }
+
+        public NetconfServerSessionNegotiatorFactory build() {
+            validate();
+            return new NetconfServerSessionNegotiatorFactory(timer, aggregatedOpService, idProvider,
+                    connectionTimeoutMillis, monitoringService, baseCapabilities, maximumIncomingChunkSize);
+        }
+
+        private void validate() {
+            requireNonNull(timer, "timer not initialized");
+            requireNonNull(aggregatedOpService, "NetconfOperationServiceFactory not initialized");
+            requireNonNull(idProvider, "SessionIdProvider not initialized");
+            checkArgument(connectionTimeoutMillis > 0, "connection time out <=0");
+            requireNonNull(monitoringService, "NetconfMonitoringService not initialized");
+
+            if (baseCapabilities == null) {
+                baseCapabilities = NetconfServerSessionNegotiatorFactory.DEFAULT_BASE_CAPABILITIES;
+            }
+        }
     }
 }

diff --git a/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactoryBuilder.java b/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactoryBuilder.java
deleted file mode 100644 (file)
index 52c5271..0000000
--- a/protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactoryBuilder.java
+++ /dev/null
@@ -1,89 +0,0 @@
-/*
- * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.netconf.server;
-
-import static com.google.common.base.Preconditions.checkArgument;
-import static java.util.Objects.requireNonNull;
-
-import io.netty.util.Timer;
-import java.util.Set;
-import org.checkerframework.checker.index.qual.NonNegative;
-import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
-import org.opendaylight.netconf.server.api.SessionIdProvider;
-import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
-import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
-
-public class NetconfServerSessionNegotiatorFactoryBuilder {
-    private Timer timer;
-    private SessionIdProvider idProvider;
-    private NetconfOperationServiceFactory aggregatedOpService;
-    private long connectionTimeoutMillis;
-    private NetconfMonitoringService monitoringService;
-    private Set<String> baseCapabilities;
-    private @NonNegative int maximumIncomingChunkSize = NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
-
-    public NetconfServerSessionNegotiatorFactoryBuilder() {
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setTimer(final Timer timer) {
-        this.timer = timer;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setIdProvider(final SessionIdProvider idProvider) {
-        this.idProvider = idProvider;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setAggregatedOpService(
-            final NetconfOperationServiceFactory aggregatedOpService) {
-        this.aggregatedOpService = aggregatedOpService;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setConnectionTimeoutMillis(final long connectionTimeoutMillis) {
-        this.connectionTimeoutMillis = connectionTimeoutMillis;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setMonitoringService(
-            final NetconfMonitoringService monitoringService) {
-        this.monitoringService = monitoringService;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setBaseCapabilities(final Set<String> baseCapabilities) {
-        this.baseCapabilities = baseCapabilities;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactoryBuilder setMaximumIncomingChunkSize(
-            final @NonNegative int maximumIncomingChunkSize) {
-        checkArgument(maximumIncomingChunkSize > 0);
-        this.maximumIncomingChunkSize = maximumIncomingChunkSize;
-        return this;
-    }
-
-    public NetconfServerSessionNegotiatorFactory build() {
-        validate();
-        return new NetconfServerSessionNegotiatorFactory(timer, aggregatedOpService, idProvider,
-                connectionTimeoutMillis, monitoringService, baseCapabilities, maximumIncomingChunkSize);
-    }
-
-    private void validate() {
-        requireNonNull(timer, "timer not initialized");
-        requireNonNull(aggregatedOpService, "NetconfOperationServiceFactory not initialized");
-        requireNonNull(idProvider, "SessionIdProvider not initialized");
-        checkArgument(connectionTimeoutMillis > 0, "connection time out <=0");
-        requireNonNull(monitoringService, "NetconfMonitoringService not initialized");
-
-        if (baseCapabilities == null) {
-            baseCapabilities = NetconfServerSessionNegotiatorFactory.DEFAULT_BASE_CAPABILITIES;
-        }
-    }
-}

diff --git a/protocol/netconf-server/src/test/java/org/opendaylight/netconf/server/ConcurrentClientsTest.java b/protocol/netconf-server/src/test/java/org/opendaylight/netconf/server/ConcurrentClientsTest.java
index abca7c6ed5ebec9698fcfd4352ea50bdb9c045f9..8e571db8344a40666ad0bab8b6cca482c4db07cd 100644 (file)
--- a/protocol/netconf-server/src/test/java/org/opendaylight/netconf/server/ConcurrentClientsTest.java
+++ b/protocol/netconf-server/src/test/java/org/opendaylight/netconf/server/ConcurrentClientsTest.java
@@ -174,7 +174,7 @@ public class ConcurrentClientsTest {
         doReturn(EMPTY_CAPABILITIES).when(monitoringService).getCapabilities();
 
         serverBootstrapFactory = new BootstrapFactory("server", threads);
-        server = TCPServer.listen(new ServerTransportInitializer(new NetconfServerSessionNegotiatorFactoryBuilder()
+        server = TCPServer.listen(new ServerTransportInitializer(NetconfServerSessionNegotiatorFactory.builder()
             .setTimer(hashedWheelTimer)
             .setAggregatedOpService(factoriesListener)
             .setIdProvider(ID_PROVIDER)