Rename NetconfHelloMessage to HelloMessage 68/105668/3
authorRobert Varga <robert.varga@pantheon.tech>
Tue, 25 Apr 2023 16:19:05 +0000 (18:19 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Tue, 25 Apr 2023 17:27:04 +0000 (19:27 +0200)
Let's keep things consistent by renaming NetconfHelloMessage to
HelloMessage -- similar to how we have NotificationMessage.

JIRA: NETCONF-1000
Change-Id: I50bfb9200dc6c7624a76eeac2b13f5324bedd7cb
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
17 files changed:
netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/AbstractNetconfSessionNegotiator.java
netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/NetconfHelloMessageToXMLEncoder.java
netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/NetconfXMLToHelloMessageDecoder.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/AbstractNetconfSessionNegotiatorTest.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/AbstractNetconfSessionTest.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/Netconf539Test.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/TestSessionNegotiator.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/handler/NetconfHelloMessageToXMLEncoderTest.java
netconf/netconf-netty-util/src/test/java/org/opendaylight/netconf/nettyutil/handler/NetconfXMLToHelloMessageDecoderTest.java
protocol/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/HelloMessage.java [moved from protocol/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessage.java with 86% similarity]
protocol/netconf-api/src/test/java/org/opendaylight/netconf/api/messages/HelloMessageTest.java [moved from protocol/netconf-api/src/test/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageTest.java with 68% similarity]
protocol/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientSessionNegotiator.java
protocol/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientSessionNegotiatorFactory.java
protocol/netconf-client/src/test/java/org/opendaylight/netconf/client/NetconfClientSessionNegotiatorTest.java
protocol/netconf-client/src/test/java/org/opendaylight/netconf/client/SimpleNetconfClientSessionListenerTest.java
protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiator.java
protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSessionNegotiatorFactory.java

index 082d4247cc4dc2fdd6d6fef5e4da26a2e7001eb8..72406263d96dec14133c36cf031c5e5f0b4e8cc0 100644 (file)
@@ -30,7 +30,7 @@ import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.netconf.api.NetconfDocumentedException;
 import org.opendaylight.netconf.api.NetconfMessage;
 import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.nettyutil.handler.FramingMechanismHandlerFactory;
 import org.opendaylight.netconf.nettyutil.handler.NetconfChunkAggregator;
@@ -77,7 +77,7 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
         LOG.debug("Default maximum incoming NETCONF chunk size is {} bytes", DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
     }
 
-    private final @NonNull NetconfHelloMessage localHello;
+    private final @NonNull HelloMessage localHello;
     protected final Channel channel;
 
     private final @NonNegative int maximumIncomingChunkSize;
@@ -91,11 +91,11 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
     @GuardedBy("this")
     private State state = State.IDLE;
 
-    protected AbstractNetconfSessionNegotiator(final NetconfHelloMessage hello, final Promise<S> promise,
+    protected AbstractNetconfSessionNegotiator(final HelloMessage hello, final Promise<S> promise,
                                                final Channel channel, final Timer timer, final L sessionListener,
                                                final long connectionTimeoutMillis,
                                                final @NonNegative int maximumIncomingChunkSize) {
-        this.localHello = requireNonNull(hello);
+        localHello = requireNonNull(hello);
         this.promise = requireNonNull(promise);
         this.channel = requireNonNull(channel);
         this.timer = timer;
@@ -106,14 +106,14 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
     }
 
     @Deprecated(since = "4.0.1", forRemoval = true)
-    protected AbstractNetconfSessionNegotiator(final NetconfHelloMessage hello, final Promise<S> promise,
+    protected AbstractNetconfSessionNegotiator(final HelloMessage hello, final Promise<S> promise,
                                                final Channel channel, final Timer timer,
                                                final L sessionListener, final long connectionTimeoutMillis) {
         this(hello, promise, channel, timer, sessionListener, connectionTimeoutMillis,
             DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
     }
 
-    protected final @NonNull NetconfHelloMessage localHello() {
+    protected final @NonNull HelloMessage localHello() {
         return localHello;
     }
 
@@ -248,7 +248,7 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
         }
     }
 
-    protected final S getSessionForHelloMessage(final NetconfHelloMessage netconfMessage)
+    protected final S getSessionForHelloMessage(final HelloMessage netconfMessage)
             throws NetconfDocumentedException {
         final Document doc = netconfMessage.getDocument();
 
@@ -260,7 +260,7 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
         return getSession(sessionListener, channel, netconfMessage);
     }
 
-    protected abstract S getSession(L sessionListener, Channel channel, NetconfHelloMessage message)
+    protected abstract S getSession(L sessionListener, Channel channel, HelloMessage message)
         throws NetconfDocumentedException;
 
     /**
@@ -316,7 +316,7 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
         LOG.debug("Changing state from : {} to : {} for channel: {}", state, newState, channel);
         checkState(isStateChangePermitted(state, newState),
                 "Cannot change state from %s to %s for channel %s", state, newState, channel);
-        this.state = newState;
+        state = newState;
     }
 
     private static boolean containsBase11Capability(final Document doc) {
@@ -376,7 +376,7 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
 
         LOG.debug("Negotiation read invoked on channel {}", channel);
         try {
-            handleMessage((NetconfHelloMessage) msg);
+            handleMessage((HelloMessage) msg);
         } catch (final Exception e) {
             LOG.debug("Unexpected error while handling negotiation message {} on channel {}", msg, channel, e);
             negotiationFailed(e);
@@ -389,5 +389,5 @@ public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconf
         negotiationFailed(cause);
     }
 
-    protected abstract void handleMessage(NetconfHelloMessage msg) throws Exception;
+    protected abstract void handleMessage(HelloMessage msg) throws Exception;
 }
index f5efdf8740dedaefaf458649c827c5309efcefee..d968b85569dc2055757e9e79f6967399fa523823 100644 (file)
@@ -16,13 +16,13 @@ import java.nio.charset.StandardCharsets;
 import java.util.Optional;
 import javax.xml.transform.TransformerException;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
 
 /**
  * Customized NetconfMessageToXMLEncoder that serializes additional header with
  * session metadata along with
- * {@link NetconfHelloMessage}
+ * {@link HelloMessage}
  * . Used by netconf clients to send information about the user, ip address,
  * protocol etc.
  *
@@ -45,12 +45,11 @@ import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader
 public final class NetconfHelloMessageToXMLEncoder extends NetconfMessageToXMLEncoder {
     @Override
     @VisibleForTesting
-    public void encode(ChannelHandlerContext ctx, NetconfMessage msg, ByteBuf out)
+    public void encode(final ChannelHandlerContext ctx, final NetconfMessage msg, final ByteBuf out)
             throws IOException, TransformerException {
-        Preconditions.checkState(msg instanceof NetconfHelloMessage, "Netconf message of type %s expected, was %s",
-                NetconfHelloMessage.class, msg.getClass());
-        Optional<NetconfHelloMessageAdditionalHeader> headerOptional = ((NetconfHelloMessage) msg)
-                .getAdditionalHeader();
+        Preconditions.checkState(msg instanceof HelloMessage, "Netconf message of type %s expected, was %s",
+                HelloMessage.class, msg.getClass());
+        Optional<NetconfHelloMessageAdditionalHeader> headerOptional = ((HelloMessage) msg).getAdditionalHeader();
 
         // If additional header present, serialize it along with netconf hello message
         if (headerOptional.isPresent()) {
index 31a3284debfe46222773f08a3facda07dbd9c7c2..3309ea0e38cb3d18d6d6f4f7c97b4437d0d83764 100644 (file)
@@ -22,7 +22,7 @@ import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.slf4j.Logger;
@@ -33,7 +33,7 @@ import org.xml.sax.SAXException;
 /**
  * Customized NetconfXMLToMessageDecoder that reads additional header with
  * session metadata from
- * {@link NetconfHelloMessage}*
+ * {@link HelloMessage}*
  * This handler should be replaced in pipeline by regular message handler as last step of negotiation.
  * It serves as a message barrier and halts all non-hello netconf messages.
  * Netconf messages after hello should be processed once the negotiation succeeded.
@@ -91,7 +91,7 @@ public final class NetconfXMLToHelloMessageDecoder extends ByteToMessageDecoder
             Document doc = XmlUtil.readXmlToDocument(new ByteArrayInputStream(bytes));
 
             final NetconfMessage message = getNetconfMessage(additionalHeader, doc);
-            if (message instanceof NetconfHelloMessage) {
+            if (message instanceof HelloMessage) {
                 Preconditions.checkState(!helloReceived,
                         "Multiple hello messages received, unexpected hello: %s", message);
                 out.add(message);
@@ -109,11 +109,11 @@ public final class NetconfXMLToHelloMessageDecoder extends ByteToMessageDecoder
 
     private static NetconfMessage getNetconfMessage(final String additionalHeader, final Document doc) {
         NetconfMessage msg = new NetconfMessage(doc);
-        if (NetconfHelloMessage.isHelloMessage(msg)) {
+        if (HelloMessage.isHelloMessage(msg)) {
             if (additionalHeader != null) {
-                return new NetconfHelloMessage(doc, NetconfHelloMessageAdditionalHeader.fromString(additionalHeader));
+                return new HelloMessage(doc, NetconfHelloMessageAdditionalHeader.fromString(additionalHeader));
             } else {
-                return new NetconfHelloMessage(doc);
+                return new HelloMessage(doc);
             }
         }
 
index 0eb90f5841928fdf77d536b7e7fb80aa65431e28..59898303b0bc28914e27faf8bd449ac7418369d7 100644 (file)
@@ -48,7 +48,7 @@ import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
@@ -73,8 +73,8 @@ public class AbstractNetconfSessionNegotiatorTest {
     private Timeout timeout;
     private EmbeddedChannel channel;
     private TestSessionNegotiator negotiator;
-    private NetconfHelloMessage hello;
-    private NetconfHelloMessage helloBase11;
+    private HelloMessage hello;
+    private HelloMessage helloBase11;
     private NetconfXMLToHelloMessageDecoder xmlToHello;
 
     @Before
@@ -87,9 +87,9 @@ public class AbstractNetconfSessionNegotiatorTest {
         channel.pipeline().addLast(NETCONF_MESSAGE_FRAME_ENCODER,
                 FramingMechanismHandlerFactory.createHandler(FramingMechanism.EOM));
         channel.pipeline().addLast(NETCONF_MESSAGE_AGGREGATOR, new NetconfEOMAggregator());
-        hello = NetconfHelloMessage.createClientHello(Set.of(), Optional.empty());
-        helloBase11 = NetconfHelloMessage.createClientHello(
-            Set.of(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1), Optional.empty());
+        hello = HelloMessage.createClientHello(Set.of(), Optional.empty());
+        helloBase11 = HelloMessage.createClientHello(Set.of(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1),
+            Optional.empty());
         doReturn(promise).when(promise).setFailure(any());
         negotiator = new TestSessionNegotiator(helloBase11, promise, channel, timer, listener, 100L);
     }
index f4b64cfc4bb7d066b150a9b87b66bf52c95dd53c..9a45d05853cd1b69750c3c15ccc98798a26d79a3 100644 (file)
@@ -28,8 +28,8 @@ import io.netty.channel.EventLoop;
 import io.netty.handler.codec.ByteToMessageDecoder;
 import io.netty.handler.codec.MessageToByteEncoder;
 import java.io.EOFException;
-import java.util.Collections;
 import java.util.Optional;
+import java.util.Set;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -38,7 +38,7 @@ import org.mockito.junit.MockitoJUnitRunner;
 import org.opendaylight.netconf.api.NetconfMessage;
 import org.opendaylight.netconf.api.NetconfSessionListener;
 import org.opendaylight.netconf.api.NetconfTerminationReason;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessage;
 
@@ -56,7 +56,7 @@ public class AbstractNetconfSessionTest {
     @Mock
     private ChannelPromise writeFuture;
 
-    private NetconfHelloMessage clientHello;
+    private HelloMessage clientHello;
 
     @Before
     public void setUp() throws Exception {
@@ -79,7 +79,7 @@ public class AbstractNetconfSessionTest {
             return null;
         }).when(eventLoop).execute(any(Runnable.class));
 
-        clientHello = NetconfHelloMessage.createClientHello(Collections.emptySet(), Optional.empty());
+        clientHello = HelloMessage.createClientHello(Set.of(), Optional.empty());
     }
 
     @Test
@@ -147,8 +147,7 @@ public class AbstractNetconfSessionTest {
     @Test
     public void testSendMessage() throws Exception {
         final TestingNetconfSession testingNetconfSession = new TestingNetconfSession(listener, channel, 1L);
-        final NetconfHelloMessage hello = NetconfHelloMessage.createClientHello(Collections.emptySet(),
-            Optional.empty());
+        final HelloMessage hello = HelloMessage.createClientHello(Set.of(), Optional.empty());
         testingNetconfSession.sendMessage(hello);
         verify(channel).writeAndFlush(hello, writeFuture);
     }
index 6b5de4b9de0cd50e443ed511a9cf6c325d4a6e5d..b2b3e0fbb64b9de63be924a2cea43fc6e17a7829 100644 (file)
@@ -24,7 +24,7 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
 import org.opendaylight.netconf.nettyutil.handler.FramingMechanismHandlerFactory;
@@ -55,7 +55,7 @@ public class Netconf539Test {
         channel.pipeline().addLast(NETCONF_MESSAGE_FRAME_ENCODER,
             FramingMechanismHandlerFactory.createHandler(FramingMechanism.EOM));
         channel.pipeline().addLast(NETCONF_MESSAGE_AGGREGATOR, new NetconfEOMAggregator());
-        final NetconfHelloMessage serverHello = NetconfHelloMessage.createClientHello(
+        final HelloMessage serverHello = HelloMessage.createClientHello(
             Set.of(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1), Optional.empty());
         negotiator = new TestSessionNegotiator(serverHello, promise, channel, new HashedWheelTimer(), listener, 100L);
     }
@@ -73,7 +73,7 @@ public class Netconf539Test {
     private void testGetSessionForHelloMessage(final String fileName) throws Exception {
         final Document helloDocument = XmlFileLoader.xmlFileToDocument(fileName);
         negotiator.startNegotiation();
-        final NetconfHelloMessage helloMessage = new NetconfHelloMessage(helloDocument);
+        final HelloMessage helloMessage = new HelloMessage(helloDocument);
         final TestingNetconfSession session = negotiator.getSessionForHelloMessage(helloMessage);
         assertNotNull(session);
         assertTrue("NetconfChunkAggregator was not installed in the Netconf pipeline",
index 802bd2b03a22644eb1569c457a72e801d7fffd03..57842b20b7ac64834e541ab36e512aae020d3b0f 100644 (file)
@@ -11,11 +11,11 @@ import io.netty.channel.Channel;
 import io.netty.util.Timer;
 import io.netty.util.concurrent.Promise;
 import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 
 final class TestSessionNegotiator
         extends AbstractNetconfSessionNegotiator<TestingNetconfSession, NetconfSessionListener<TestingNetconfSession>> {
-    TestSessionNegotiator(final NetconfHelloMessage hello, final Promise<TestingNetconfSession> promise,
+    TestSessionNegotiator(final HelloMessage hello, final Promise<TestingNetconfSession> promise,
             final Channel channel, final Timer timer,
             final NetconfSessionListener<TestingNetconfSession> sessionListener, final long connectionTimeoutMillis) {
         super(hello, promise, channel, timer, sessionListener, connectionTimeoutMillis, 16384);
@@ -23,12 +23,12 @@ final class TestSessionNegotiator
 
     @Override
     protected TestingNetconfSession getSession(final NetconfSessionListener<TestingNetconfSession> sessionListener,
-            final Channel channel, final NetconfHelloMessage message) {
+            final Channel channel, final HelloMessage message) {
         return new TestingNetconfSession(sessionListener, channel, 0L);
     }
 
     @Override
-    protected void handleMessage(final NetconfHelloMessage netconfHelloMessage) {
+    protected void handleMessage(final HelloMessage netconfHelloMessage) {
         // No-op
     }
 }
\ No newline at end of file
index 9f9cdc5c9d5602c1afe31056438bf15c34144ed7..c4da9a1d08e5e35271a2d6445c67e76e31f636e2 100644 (file)
@@ -10,6 +10,7 @@ package org.opendaylight.netconf.nettyutil.handler;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.not;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
@@ -19,7 +20,7 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 
@@ -31,7 +32,7 @@ public class NetconfHelloMessageToXMLEncoderTest {
 
     @Test
     public void testEncode() throws Exception {
-        final NetconfMessage msg = new NetconfHelloMessage(XmlUtil.readXmlToDocument(
+        final NetconfMessage msg = new HelloMessage(XmlUtil.readXmlToDocument(
                 "<hello xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"/>"),
                 NetconfHelloMessageAdditionalHeader.fromString("[tomas;10.0.0.0:10000;tcp;client;]"));
         final ByteBuf destination = Unpooled.buffer();
@@ -44,7 +45,7 @@ public class NetconfHelloMessageToXMLEncoderTest {
 
     @Test
     public void testEncodeNoHeader() throws Exception {
-        final NetconfMessage msg = new NetconfHelloMessage(XmlUtil.readXmlToDocument(
+        final NetconfMessage msg = new HelloMessage(XmlUtil.readXmlToDocument(
                 "<hello xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"/>"));
         final ByteBuf destination = Unpooled.buffer();
         new NetconfHelloMessageToXMLEncoder().encode(ctx, msg, destination);
@@ -54,10 +55,10 @@ public class NetconfHelloMessageToXMLEncoderTest {
         assertThat(encoded, containsString("<hello xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"/>"));
     }
 
-    @Test(expected = IllegalStateException.class)
+    @Test
     public void testEncodeNotHello() throws Exception {
         final NetconfMessage msg = new NetconfMessage(XmlUtil.readXmlToDocument(
                 "<hello xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"/>"));
-        new NetconfHelloMessageToXMLEncoder().encode(ctx, msg, null);
+        assertThrows(IllegalStateException.class, () -> new NetconfHelloMessageToXMLEncoder().encode(ctx, msg, null));
     }
 }
index 4b999eb7c90adf37be7cdbf9b8a215bf6602fdac..b9f0d18daf70570e773abe387503eb5039f91971 100644 (file)
@@ -19,7 +19,7 @@ import java.util.ArrayList;
 import java.util.List;
 import org.hamcrest.CoreMatchers;
 import org.junit.Test;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 
 public class NetconfXMLToHelloMessageDecoderTest {
@@ -33,8 +33,8 @@ public class NetconfXMLToHelloMessageDecoderTest {
         new NetconfXMLToHelloMessageDecoder().decode(null, src, out);
 
         assertEquals(1, out.size());
-        assertThat(out.get(0), CoreMatchers.instanceOf(NetconfHelloMessage.class));
-        final NetconfHelloMessage hello = (NetconfHelloMessage) out.get(0);
+        assertThat(out.get(0), CoreMatchers.instanceOf(HelloMessage.class));
+        final HelloMessage hello = (HelloMessage) out.get(0);
         assertTrue(hello.getAdditionalHeader().isPresent());
         assertEquals("[tomas;10.0.0.0:10000;tcp;client;]" + System.lineSeparator(),
                 hello.getAdditionalHeader().orElseThrow().toFormattedString());
@@ -50,8 +50,8 @@ public class NetconfXMLToHelloMessageDecoderTest {
         new NetconfXMLToHelloMessageDecoder().decode(null, src, out);
 
         assertEquals(1, out.size());
-        assertThat(out.get(0), CoreMatchers.instanceOf(NetconfHelloMessage.class));
-        final NetconfHelloMessage hello = (NetconfHelloMessage) out.get(0);
+        assertThat(out.get(0), CoreMatchers.instanceOf(HelloMessage.class));
+        final HelloMessage hello = (HelloMessage) out.get(0);
         assertFalse(hello.getAdditionalHeader().isPresent());
     }
 
similarity index 86%
rename from protocol/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessage.java
rename to protocol/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/HelloMessage.java
index f2598b5c1d570c8dc6cd06f23865d73a396ac41c..b2e8a0e357a88cbc12af0840202efd887400701d 100644 (file)
@@ -23,18 +23,18 @@ import org.w3c.dom.Element;
  *
  * @see NetconfHelloMessageAdditionalHeader
  */
-public final class NetconfHelloMessage extends NetconfMessage {
+public final class HelloMessage extends NetconfMessage {
     private static final String HELLO_TAG = "hello";
 
     private final NetconfHelloMessageAdditionalHeader additionalHeader;
 
-    public NetconfHelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
+    public HelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
         super(doc);
         checkHelloMessage(doc);
         this.additionalHeader = additionalHeader;
     }
 
-    public NetconfHelloMessage(final Document doc) {
+    public HelloMessage(final Document doc) {
         this(doc, null);
     }
 
@@ -50,9 +50,9 @@ public final class NetconfHelloMessage extends NetconfMessage {
         }
     }
 
-    public static NetconfHelloMessage createClientHello(final Iterable<String> capabilities,
+    public static HelloMessage createClientHello(final Iterable<String> capabilities,
             final Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
-        return new NetconfHelloMessage(createHelloMessageDoc(capabilities), additionalHeaderOptional.orElse(null));
+        return new HelloMessage(createHelloMessageDoc(capabilities), additionalHeaderOptional.orElse(null));
     }
 
     private static Document createHelloMessageDoc(final Iterable<String> capabilities) {
@@ -75,13 +75,13 @@ public final class NetconfHelloMessage extends NetconfMessage {
         return doc;
     }
 
-    public static NetconfHelloMessage createServerHello(final Set<String> capabilities, final long sessionId) {
+    public static HelloMessage createServerHello(final Set<String> capabilities, final long sessionId) {
         Document doc = createHelloMessageDoc(capabilities);
         Element sessionIdElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
                 XmlNetconfConstants.SESSION_ID);
         sessionIdElement.setTextContent(Long.toString(sessionId));
         doc.getDocumentElement().appendChild(sessionIdElement);
-        return new NetconfHelloMessage(doc);
+        return new HelloMessage(doc);
     }
 
     public static boolean isHelloMessage(final NetconfMessage msg) {
similarity index 68%
rename from protocol/netconf-api/src/test/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageTest.java
rename to protocol/netconf-api/src/test/java/org/opendaylight/netconf/api/messages/HelloMessageTest.java
index e4280840cc01a94980e1a89a5df52d64563a72fd..ca534731980c5611a24f99de56ad5258beaf9af8 100644 (file)
@@ -15,17 +15,16 @@ import java.util.Set;
 import org.junit.Test;
 import org.opendaylight.netconf.api.NetconfDocumentedException;
 
-public class NetconfHelloMessageTest {
-    private final Set<String> caps = Set.of("cap1");
-
+public class HelloMessageTest {
     @Test
     public void testConstructor() throws NetconfDocumentedException {
+        var caps = Set.of("cap1");
         var additionalHeader = new NetconfHelloMessageAdditionalHeader("name", "host", "1", "transp", "id");
-        var message = NetconfHelloMessage.createClientHello(caps, Optional.of(additionalHeader));
-        assertTrue(NetconfHelloMessage.isHelloMessage(message));
+        var message = HelloMessage.createClientHello(caps, Optional.of(additionalHeader));
+        assertTrue(HelloMessage.isHelloMessage(message));
         assertEquals(Optional.of(additionalHeader), message.getAdditionalHeader());
 
-        var serverMessage = NetconfHelloMessage.createServerHello(caps, 100L);
-        assertTrue(NetconfHelloMessage.isHelloMessage(serverMessage));
+        var serverMessage = HelloMessage.createServerHello(caps, 100L);
+        assertTrue(HelloMessage.isHelloMessage(serverMessage));
     }
 }
index 9d51f6950af7fa491783a68bd1903d8e70ce7e1f..b074ac70a90f5797141142a22a2f48c4eadb04af 100644 (file)
@@ -22,7 +22,7 @@ import javax.xml.xpath.XPathExpression;
 import org.checkerframework.checker.index.qual.NonNegative;
 import org.opendaylight.netconf.api.NetconfDocumentedException;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.opendaylight.netconf.nettyutil.AbstractChannelInitializer;
@@ -52,7 +52,7 @@ class NetconfClientSessionNegotiator
 
     private final NetconfStartExiMessage startExi;
 
-    NetconfClientSessionNegotiator(final NetconfHelloMessage hello, final NetconfStartExiMessage startExi,
+    NetconfClientSessionNegotiator(final HelloMessage hello, final NetconfStartExiMessage startExi,
             final Promise<NetconfClientSession> promise, final Channel channel, final Timer timer,
             final NetconfClientSessionListener sessionListener, final long connectionTimeoutMillis,
             final @NonNegative int maximumIncomingChunkSize) {
@@ -62,7 +62,7 @@ class NetconfClientSessionNegotiator
 
     @SuppressWarnings("checkstyle:IllegalCatch")
     @Override
-    protected void handleMessage(final NetconfHelloMessage netconfMessage) throws NetconfDocumentedException {
+    protected void handleMessage(final HelloMessage netconfMessage) throws NetconfDocumentedException {
         if (!ifNegotiatedAlready()) {
             LOG.debug("Server hello message received, starting negotiation on channel {}", channel);
             try {
@@ -109,7 +109,7 @@ class NetconfClientSessionNegotiator
         });
     }
 
-    private boolean shouldUseExi(final NetconfHelloMessage helloMsg) {
+    private boolean shouldUseExi(final HelloMessage helloMsg) {
         return containsExi10Capability(helloMsg.getDocument()) && containsExi10Capability(localHello().getDocument());
     }
 
@@ -143,7 +143,7 @@ class NetconfClientSessionNegotiator
 
     @Override
     protected NetconfClientSession getSession(final NetconfClientSessionListener sessionListener, final Channel channel,
-                                              final NetconfHelloMessage message) {
+                                              final HelloMessage message) {
         final long sessionId = extractSessionId(message.getDocument());
 
         // Copy here is important: it disconnects the strings from the document
index 6215f4f0a82b2db3e8f21f06400a74e27d749ce7..af1ef5fce0b2826ab6dbb10b67e15ad9f9d65dc9 100644 (file)
@@ -17,7 +17,7 @@ import java.util.Optional;
 import java.util.Set;
 import org.checkerframework.checker.index.qual.NonNegative;
 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
@@ -130,7 +130,7 @@ public class NetconfClientSessionNegotiatorFactory
             final NetconfSessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
             final Channel channel, final Promise<NetconfClientSession> promise) {
         return new NetconfClientSessionNegotiator(
-            NetconfHelloMessage.createClientHello(clientCapabilities, additionalHeader),
+            HelloMessage.createClientHello(clientCapabilities, additionalHeader),
             NetconfStartExiMessage.create(options, START_EXI_MESSAGE_ID), promise, channel, timer,
                 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis, maximumIncomingChunkSize);
     }
index 78daaeb3399d85d1aacf6306abaec0963610377b..0a824539231b3c8efa3296a6f099a73868068adf 100644 (file)
@@ -39,7 +39,7 @@ import java.util.Set;
 import org.junit.Before;
 import org.junit.Test;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
 import org.opendaylight.netconf.nettyutil.handler.NetconfEXIToMessageDecoder;
@@ -51,7 +51,7 @@ import org.opendaylight.netconf.util.test.XmlFileLoader;
 import org.w3c.dom.Document;
 
 public class NetconfClientSessionNegotiatorTest {
-    private NetconfHelloMessage helloMessage;
+    private HelloMessage helloMessage;
     private ChannelPipeline pipeline;
     private ChannelPromise future;
     private Channel channel;
@@ -59,7 +59,7 @@ public class NetconfClientSessionNegotiatorTest {
 
     @Before
     public void setUp() {
-        helloMessage = NetconfHelloMessage.createClientHello(Set.of("exi:1.0"), Optional.empty());
+        helloMessage = HelloMessage.createClientHello(Set.of("exi:1.0"), Optional.empty());
         pipeline = mockChannelPipeline();
         future = mockChannelFuture();
         channel = mockChannel();
@@ -135,17 +135,13 @@ public class NetconfClientSessionNegotiatorTest {
             timeout, 16384);
     }
 
-    private static NetconfHelloMessage createHelloMsg(final String name) throws Exception {
+    private static HelloMessage createHelloMsg(final String name) throws Exception {
         final InputStream stream = NetconfClientSessionNegotiatorTest.class.getResourceAsStream(name);
-        final Document doc = XmlUtil.readXmlToDocument(stream);
-
-        return new NetconfHelloMessage(doc);
+        return new HelloMessage(XmlUtil.readXmlToDocument(stream));
     }
 
     private static Set<String> createCapabilities(final String name) throws Exception {
-        NetconfHelloMessage hello = createHelloMsg(name);
-
-        return ImmutableSet.copyOf(NetconfMessageUtil.extractCapabilitiesFromHello(hello.getDocument()));
+        return ImmutableSet.copyOf(NetconfMessageUtil.extractCapabilitiesFromHello(createHelloMsg(name).getDocument()));
     }
 
     @Test
@@ -156,7 +152,7 @@ public class NetconfClientSessionNegotiatorTest {
 
         negotiator.channelActive(null);
         doReturn(null).when(future).cause();
-        negotiator.handleMessage(NetconfHelloMessage.createServerHello(Set.of("a", "b"), 10));
+        negotiator.handleMessage(HelloMessage.createServerHello(Set.of("a", "b"), 10));
         verify(promise).setSuccess(any());
     }
 
@@ -168,7 +164,7 @@ public class NetconfClientSessionNegotiatorTest {
         NetconfClientSessionNegotiator negotiator = createNetconfClientSessionNegotiator(promise, null);
 
         doReturn(null).when(future).cause();
-        negotiator.handleMessage(NetconfHelloMessage.createServerHello(Set.of("a", "b"), 10));
+        negotiator.handleMessage(HelloMessage.createServerHello(Set.of("a", "b"), 10));
         negotiator.channelActive(null);
         verify(promise).setSuccess(any());
     }
@@ -190,7 +186,7 @@ public class NetconfClientSessionNegotiatorTest {
 
         ChannelHandlerContext handlerContext = mock(ChannelHandlerContext.class);
         doReturn(pipeline).when(handlerContext).pipeline();
-        negotiator.handleMessage(NetconfHelloMessage.createServerHello(Set.of("exi:1.0"), 10));
+        negotiator.handleMessage(HelloMessage.createServerHello(Set.of("exi:1.0"), 10));
         Document expectedResult = XmlFileLoader.xmlFileToDocument("netconfMessages/rpc-reply_ok.xml");
         channelInboundHandlerAdapter.channelRead(handlerContext, new NetconfMessage(expectedResult));
 
index 65e1c8e109f280bbd3f37b67a453d51c6fedb218..209c2cc85300b1d4cfad05e29d572ad467023b7a 100644 (file)
@@ -25,12 +25,12 @@ import java.util.Set;
 import org.junit.Before;
 import org.junit.Test;
 import org.opendaylight.netconf.api.NetconfMessage;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 
 public class SimpleNetconfClientSessionListenerTest {
     private Channel channel;
     private ChannelPromise channelFuture;
-    private NetconfHelloMessage helloMessage;
+    private HelloMessage helloMessage;
     private NetconfMessage message;
     private NetconfClientSessionListener sessionListener;
     private NetconfClientSession clientSession;
@@ -45,7 +45,7 @@ public class SimpleNetconfClientSessionListenerTest {
         doReturn(channelFuture).when(channel).writeAndFlush(any(), any(ChannelPromise.class));
         doReturn(channelFuture).when(channelFuture).addListener(any(GenericFutureListener.class));
         final var caps = Set.of("a", "b");
-        helloMessage = NetconfHelloMessage.createServerHello(caps, 10);
+        helloMessage = HelloMessage.createServerHello(caps, 10);
         message = new NetconfMessage(helloMessage.getDocument());
         sessionListener = mock(NetconfClientSessionListener.class);
         clientSession = new NetconfClientSession(sessionListener, channel, 20L, caps);
index ab60af2aeae9ab0edb4d86ab9cc0b4c10547af4a..102b048aa921d36972cf3c69b5d890c46c13ed21 100644 (file)
@@ -17,7 +17,7 @@ import java.util.AbstractMap.SimpleImmutableEntry;
 import java.util.Map;
 import org.checkerframework.checker.index.qual.NonNegative;
 import org.opendaylight.netconf.api.NetconfDocumentedException;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
 import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
 import org.slf4j.Logger;
@@ -30,7 +30,7 @@ public final class NetconfServerSessionNegotiator
 
     private final long sessionId;
 
-    NetconfServerSessionNegotiator(final NetconfHelloMessage hello, final long sessionId,
+    NetconfServerSessionNegotiator(final HelloMessage hello, final long sessionId,
             final Promise<NetconfServerSession> promise, final Channel channel, final Timer timer,
             final NetconfServerSessionListener sessionListener, final long connectionTimeoutMillis,
             final @NonNegative int maximumIncomingChunkSize) {
@@ -40,7 +40,7 @@ public final class NetconfServerSessionNegotiator
     }
 
     @Override
-    protected void handleMessage(final NetconfHelloMessage netconfMessage) throws NetconfDocumentedException {
+    protected void handleMessage(final HelloMessage netconfMessage) throws NetconfDocumentedException {
         NetconfServerSession session = getSessionForHelloMessage(netconfMessage);
         replaceHelloMessageInboundHandler(session);
         // Negotiation successful after all non hello messages were processed
@@ -49,7 +49,7 @@ public final class NetconfServerSessionNegotiator
 
     @Override
     protected NetconfServerSession getSession(final NetconfServerSessionListener sessionListener, final Channel channel,
-            final NetconfHelloMessage message) {
+            final HelloMessage message) {
         final var additionalHeader = message.getAdditionalHeader();
         final var parsedHeader = additionalHeader.orElseGet(() -> {
             final var hostName = getHostName(channel.localAddress());
@@ -73,9 +73,9 @@ public final class NetconfServerSessionNegotiator
             return new SimpleImmutableEntry<>(Integer.toString(inetSocketAddress.getPort()),
                     inetSocketAddress.getHostString());
         } else if (socketAddress instanceof LocalAddress localAddress) {
-            return new SimpleImmutableEntry<>(UNKNOWN, localAddress.id());
+            return Map.entry(UNKNOWN, localAddress.id());
         } else {
-            return new SimpleImmutableEntry<>(UNKNOWN, UNKNOWN);
+            return Map.entry(UNKNOWN, UNKNOWN);
         }
     }
 }
index f3908b2ae3c77392ad831dd28e16e65f9725b4bd..06be5b3c324a6ddef2b1732c716124480336954e 100644 (file)
@@ -18,7 +18,7 @@ import java.net.SocketAddress;
 import java.util.Set;
 import org.checkerframework.checker.index.qual.NonNegative;
 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
@@ -132,10 +132,10 @@ public class NetconfServerSessionNegotiatorFactory
         return aggregatedOpService;
     }
 
-    private NetconfHelloMessage createHelloMessage(
-            final long sessionId, final NetconfMonitoringService capabilityProvider) {
-        return NetconfHelloMessage.createServerHello(Sets.union(transformCapabilities(capabilityProvider
-                .getCapabilities()), baseCapabilities), sessionId);
+    private HelloMessage createHelloMessage(final long sessionId, final NetconfMonitoringService capabilityProvider) {
+        return HelloMessage.createServerHello(Sets.union(
+            transformCapabilities(capabilityProvider.getCapabilities()), baseCapabilities),
+            sessionId);
     }
 
     public static Set<String> transformCapabilities(final Capabilities capabilities) {