protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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 package org.opendaylight.netconf.server;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.collect.Sets;
  15 import io.netty.channel.Channel;
  16 import io.netty.util.concurrent.Promise;
  17 import java.net.SocketAddress;
  18 import java.util.HashSet;
  19 import java.util.Set;
  20 import org.checkerframework.checker.index.qual.NonNegative;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.netconf.api.CapabilityURN;
  23 import org.opendaylight.netconf.api.messages.HelloMessage;
  24 import org.opendaylight.netconf.common.NetconfTimer;
  25 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
  26 import org.opendaylight.netconf.server.api.SessionIdProvider;
  27 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
  28 import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
  29 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  30 import org.opendaylight.netconf.server.osgi.NetconfOperationRouterImpl;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  32
  33 // non-final for testing and netconf-testtool (for some reason)
  34 public class NetconfServerSessionNegotiatorFactory {
  35     public static final ImmutableSet<String> DEFAULT_BASE_CAPABILITIES = ImmutableSet.of(
  36         CapabilityURN.BASE,
  37         CapabilityURN.BASE_1_1,
  38         CapabilityURN.EXI,
  39         CapabilityURN.NOTIFICATION);
  40
  41     private final @NonNegative int maximumIncomingChunkSize;
  42     private final NetconfTimer timer;
  43     private final SessionIdProvider idProvider;
  44     private final NetconfOperationServiceFactory aggregatedOpService;
  45     private final long connectionTimeoutMillis;
  46     private final NetconfMonitoringService monitoringService;
  47     private final Set<String> baseCapabilities;
  48
  49     protected NetconfServerSessionNegotiatorFactory(final NetconfTimer timer,
  50             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  51             final long connectionTimeoutMillis,  final NetconfMonitoringService monitoringService,
  52             final Set<String> baseCapabilities) {
  53         this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, baseCapabilities,
  54             NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
  55     }
  56
  57     private NetconfServerSessionNegotiatorFactory(final NetconfTimer timer,
  58             final NetconfOperationServiceFactory netconfOperationProvider, final SessionIdProvider idProvider,
  59             final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
  60             final Set<String> baseCapabilities, final @NonNegative int maximumIncomingChunkSize) {
  61         this.timer = requireNonNull(timer);
  62         aggregatedOpService = netconfOperationProvider;
  63         this.idProvider = idProvider;
  64         this.connectionTimeoutMillis = connectionTimeoutMillis;
  65         this.monitoringService = monitoringService;
  66         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  67         this.baseCapabilities = validateBaseCapabilities(baseCapabilities == null ? DEFAULT_BASE_CAPABILITIES :
  68                 baseCapabilities);
  69     }
  70
  71     private static ImmutableSet<String> validateBaseCapabilities(final Set<String> baseCapabilities) {
  72         // Check base capabilities to be supported by the server
  73         final var unknownBaseCaps = Sets.difference(baseCapabilities, DEFAULT_BASE_CAPABILITIES);
  74         if (!unknownBaseCaps.isEmpty()) {
  75             throw new IllegalArgumentException(
  76                 "Base capabilities that will be supported by netconf server have to be subset of "
  77                     + DEFAULT_BASE_CAPABILITIES + ", unknown base capabilities: " + unknownBaseCaps);
  78         }
  79
  80         return ImmutableSet.<String>builder()
  81             .addAll(baseCapabilities)
  82             // Base 1.0 capability is supported by default
  83             .add(CapabilityURN.BASE)
  84             .build();
  85     }
  86
  87     public static @NonNull Builder builder() {
  88         return new Builder();
  89     }
  90
  91     /**
  92      * Get session negotiator.
  93      *
  94      * @param channel                       Underlying channel
  95      * @param promise                       Promise to be notified
  96      * @return session negotiator
  97      */
  98     public NetconfServerSessionNegotiator getSessionNegotiator(final Channel channel,
  99             final Promise<NetconfServerSession> promise) {
 100         final var sessionId = idProvider.getNextSessionId();
 101         final var service = getOperationServiceForAddress(sessionId,
 102             channel.parent() == null ? null : channel.parent().localAddress());
 103         final var capabilities = new HashSet<>(baseCapabilities);
 104         for (var capability : monitoringService.getCapabilities().requireCapability()) {
 105             capabilities.add(capability.getValue());
 106         }
 107
 108         return new NetconfServerSessionNegotiator(HelloMessage.createServerHello(capabilities, sessionId), sessionId,
 109             promise, channel, timer,
 110             new NetconfServerSessionListener(new NetconfOperationRouterImpl(service, monitoringService, sessionId),
 111                 monitoringService, service),
 112             connectionTimeoutMillis, maximumIncomingChunkSize);
 113     }
 114
 115     protected NetconfOperationService getOperationServiceForAddress(final SessionIdType sessionId,
 116             final SocketAddress socketAddress) {
 117         return aggregatedOpService.createService(sessionId);
 118     }
 119
 120     protected final NetconfOperationServiceFactory getOperationServiceFactory() {
 121         return aggregatedOpService;
 122     }
 123
 124     public static final class Builder {
 125         private @NonNegative int maximumIncomingChunkSize =
 126             NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
 127         private NetconfTimer timer;
 128         private SessionIdProvider idProvider;
 129         private NetconfOperationServiceFactory aggregatedOpService;
 130         private long connectionTimeoutMillis;
 131         private NetconfMonitoringService monitoringService;
 132         private Set<String> baseCapabilities;
 133
 134         private Builder() {
 135             // Hidden on purpose
 136         }
 137
 138         public Builder setTimer(final NetconfTimer timer) {
 139             this.timer = requireNonNull(timer);
 140             return this;
 141         }
 142
 143         public Builder setIdProvider(final SessionIdProvider idProvider) {
 144             this.idProvider = idProvider;
 145             return this;
 146         }
 147
 148         public Builder setAggregatedOpService(
 149                 final NetconfOperationServiceFactory aggregatedOpService) {
 150             this.aggregatedOpService = aggregatedOpService;
 151             return this;
 152         }
 153
 154         public Builder setConnectionTimeoutMillis(final long connectionTimeoutMillis) {
 155             this.connectionTimeoutMillis = connectionTimeoutMillis;
 156             return this;
 157         }
 158
 159         public Builder setMonitoringService(
 160                 final NetconfMonitoringService monitoringService) {
 161             this.monitoringService = monitoringService;
 162             return this;
 163         }
 164
 165         public Builder setBaseCapabilities(final Set<String> baseCapabilities) {
 166             this.baseCapabilities = baseCapabilities;
 167             return this;
 168         }
 169
 170         public Builder setMaximumIncomingChunkSize(final @NonNegative int maximumIncomingChunkSize) {
 171             checkArgument(maximumIncomingChunkSize > 0);
 172             this.maximumIncomingChunkSize = maximumIncomingChunkSize;
 173             return this;
 174         }
 175
 176         public NetconfServerSessionNegotiatorFactory build() {
 177             validate();
 178             return new NetconfServerSessionNegotiatorFactory(timer, aggregatedOpService, idProvider,
 179                     connectionTimeoutMillis, monitoringService, baseCapabilities, maximumIncomingChunkSize);
 180         }
 181
 182         private void validate() {
 183             requireNonNull(timer, "timer not initialized");
 184             requireNonNull(aggregatedOpService, "NetconfOperationServiceFactory not initialized");
 185             requireNonNull(idProvider, "SessionIdProvider not initialized");
 186             checkArgument(connectionTimeoutMillis > 0, "connection time out <=0");
 187             requireNonNull(monitoringService, "NetconfMonitoringService not initialized");
 188
 189             if (baseCapabilities == null) {
 190                 baseCapabilities = NetconfServerSessionNegotiatorFactory.DEFAULT_BASE_CAPABILITIES;
 191             }
 192         }
 193     }
 194 }