Refactor FramingMechanismHandlerFactory

[netconf.git] / netconf / netconf-netty-util / src / main / java / org / opendaylight / netconf / nettyutil / handler / FramingMechanismEncoder.java

diff --git a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismHandlerFactory.java b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismEncoder.java
similarity index 51%
rename from netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismHandlerFactory.java
rename to netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismEncoder.java
index 9294853d956065a4a1bd307df0cc482c3bfd2e63..66cf5a58935bcda9b574c3a071791b2f5ed7c334 100644 (file)
--- a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismHandlerFactory.java
+++ b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/FramingMechanismEncoder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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,
@@ -9,18 +9,29 @@ package org.opendaylight.netconf.nettyutil.handler;
 
 import io.netty.buffer.ByteBuf;
 import io.netty.handler.codec.MessageToByteEncoder;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.netconf.api.messages.FramingMechanism;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public final class FramingMechanismHandlerFactory {
-    private static final Logger LOG = LoggerFactory.getLogger(FramingMechanismHandlerFactory.class);
+/**
+ * An channel handler framing outbound messages into specified framing.
+ */
+public abstract sealed class FramingMechanismEncoder extends MessageToByteEncoder<ByteBuf>
+        permits ChunkedFramingMechanismEncoder, EOMFramingMechanismEncoder {
+    private static final Logger LOG = LoggerFactory.getLogger(FramingMechanismEncoder.class);
 
-    private FramingMechanismHandlerFactory() {
-        // not called - private constructor for utility class
+    FramingMechanismEncoder() {
+        // Hidden on purpose
     }
 
-    public static MessageToByteEncoder<ByteBuf> createHandler(final FramingMechanism framingMechanism) {
+    /**
+     * Return a {@link FramingMechanismEncoder} for specified {@link FramingMechanism}.
+     *
+     * @param framingMechanism Desired {@link FramingMechanism}
+     * @return A {@link FramingMechanismEncoder}
+     */
+    public static final @NonNull FramingMechanismEncoder of(final FramingMechanism framingMechanism) {
         LOG.debug("{} framing mechanism was selected.", framingMechanism);
         return switch (framingMechanism) {
             case CHUNK -> new ChunkedFramingMechanismEncoder();