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

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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.nettyutil.handler;
   9
  10 import io.netty.buffer.ByteBuf;
  11 import io.netty.handler.codec.MessageToByteEncoder;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.netconf.api.messages.FramingMechanism;
  14 import org.slf4j.Logger;
  15 import org.slf4j.LoggerFactory;
  16
  17 /**
  18  * An channel handler framing outbound messages into specified framing.
  19  */
  20 public abstract sealed class FramingMechanismEncoder extends MessageToByteEncoder<ByteBuf>
  21         permits ChunkedFramingMechanismEncoder, EOMFramingMechanismEncoder {
  22     private static final Logger LOG = LoggerFactory.getLogger(FramingMechanismEncoder.class);
  23
  24     FramingMechanismEncoder() {
  25         // Hidden on purpose
  26     }
  27
  28     /**
  29      * Return a {@link FramingMechanismEncoder} for specified {@link FramingMechanism}.
  30      *
  31      * @param framingMechanism Desired {@link FramingMechanism}
  32      * @return A {@link FramingMechanismEncoder}
  33      */
  34     public static final @NonNull FramingMechanismEncoder of(final FramingMechanism framingMechanism) {
  35         LOG.debug("{} framing mechanism was selected.", framingMechanism);
  36         return switch (framingMechanism) {
  37             case CHUNK -> new ChunkedFramingMechanismEncoder();
  38             case EOM -> new EOMFramingMechanismEncoder();
  39         };
  40     }
  41 }