netconf/netconf-util/src/main/java/org/opendaylight/netconf/util/messages/FramingMechanism.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.util.messages;
   9
  10 import org.eclipse.jdt.annotation.NonNullByDefault;
  11
  12 /**
  13  * Known NETCONF framing mechanisms.
  14  */
  15 @NonNullByDefault
  16 public enum FramingMechanism {
  17     /**
  18      * Chunk framing mechanism, as defined in
  19      * <a href="https://tools.ietf.org/html/rfc6242#section-4.2">RFC6242 Section 4.2</a>.
  20      */
  21     CHUNK,
  22     /**
  23      * End-of-Message framing mechanism, as defined in
  24      * <a href="https://tools.ietf.org/html/rfc6242#section-4.3">RFC6242 Section 4.3</a>.
  25      */
  26     EOM;
  27
  28     /**
  29      * String literal for a start of chunk, i.e. {@code LF HASH} part of {@code chunk} ABNF.
  30      */
  31     public static final String CHUNK_START_STR = "\n#";
  32     /**
  33      * String representing the end of a chunk, i.e. the {@code LF HASH HASH LF} production {@code end-of-chunks} ABNF.
  34      */
  35     public static final String CHUNK_END_STR = "\n##\n";
  36     /**
  37      * String representing the End-Of-Message delimiter.
  38      */
  39     public static final String EOM_STR = "]]>]]>";
  40 }